Mavrck List Member API

openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO List Member API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: ListMember
paths:
  /list-members/{actionGroupId}:
    get:
      tags:
      - ListMember
      x-handler: lists/list_member_controller.js
      summary: Retrieve an action group's list members.
      x-access:
      - administrator
      operationId: getListMembers
      parameters:
      - name: actionGroupId
        in: path
        required: true
        schema:
          type: integer
      - name: participating
        in: query
        schema:
          type: boolean
      - $ref: '#/components/parameters/orderByParam'
      - $ref: '#/components/parameters/orderDirection'
      responses:
        '200':
          description: An array of list members
          content:
            application/json:
              schema:
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListMemberDeprecated'
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Action group not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
      - ListMember
      x-handler: lists/list_member_controller.js
      x-access:
      - administrator
      operationId: updateListMembers
      summary: Update multiple list members.
      parameters:
      - name: actionGroupId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: List members updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Access forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: One or more list members not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                globalUserIds:
                  type: array
                  items:
                    type: integer
                dueDate:
                  type: string
                draftDueDate:
                  type: string
                queryFilter:
                  $ref: '#/components/schemas/ActionGroupCandidateQueryFilter'
  /list-members/{actionGroupId}/{globalUserId}:
    get:
      tags:
      - ListMember
      operationId: getListMember
      summary: Retrieve a list member.
      x-handler: lists/list_member_controller.js
      x-access:
      - administrator
      parameters:
      - name: actionGroupId
        in: path
        description: ID of action group
        required: true
        schema:
          type: integer
      - name: globalUserId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A candidate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionGroupCandidate'
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Action group or candidate not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      tags:
      - ListMember
      x-handler: lists/list_member_controller.js
      x-access:
      - administrator
      operationId: updateListMember
      summary: Update a list member.
      parameters:
      - name: actionGroupId
        in: path
        required: true
        schema:
          type: integer
      - name: globalUserId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: List member updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Access forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: List member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                proposal:
                  type: object
                  properties:
                    concept:
                      type: string
                    quote:
                      type: number
                      format: double
                    comment:
                      type: string
                  required:
                  - comment
components:
  schemas:
    ResponseMetadata:
      properties:
        limit:
          type: number
          format: double
        offset:
          type: number
          format: double
        status:
          type: string
          enum:
          - failure
          - success
        totalCount:
          type: number
          format: double
      type: object
      additionalProperties: false
    BrandDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for a brand.
        name:
          type: string
          description: Name of the brand.
        logo:
          type: string
        accentColor:
          type: string
        buttonColor:
          type: string
        associatedWithCampaign:
          type: boolean
          description: A flag indicating whether this brand has been associated with a campaign. If this is true, then this brand cannot be deleted.
    BazaarVoiceAppProductDeprecated:
      type: object
      properties:
        reviewProductId:
          type: integer
          description: Product id assigned by Mavrck
        externalBazaarProductId:
          type: string
          description: Product id assigned by BazaarVoice
    IncentiveTermsAndConditionsDeprecated:
      type: object
      properties:
        template:
          x-access:
          - administrator
          - root
          type: string
        preview:
          type: string
        params:
          x-access:
          - administrator
          - root
          type: object
    Blog:
      properties:
        globalUserId:
          type:
          - number
          - 'null'
          format: double
        language:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        platform:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      type: object
      additionalProperties: false
    NetworkName:
      type: string
      enum:
      - Blog
      - Facebook
      - Facebook Group
      - Facebook Live
      - Facebook Reel
      - Image
      - Instagram
      - Instagram Reel
      - Instagram Story
      - LinkedIn
      - Pinterest
      - Snapchat Story
      - TikTok
      - Twitch Stream
      - Twitter
      - Video
      - YouTube Video
      - YouTube Shorts
    VisualSafeSearchDeprecated:
      type: object
      properties:
        adult:
          type: string
        racy:
          type: string
        medical:
          type: string
        spoof:
          type: string
        violence:
          type: string
    ActionGroupCandidate:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/GlobalUserDeprecated'
        customStatus:
          $ref: '#/components/schemas/ListCustomStatusDeprecated'
        customInfluencerStatus:
          $ref: '#/components/schemas/ListCustomInfluencerStatusDeprecated'
        listMemberCostAndPerformance:
          $ref: '#/components/schemas/ListMemberCostAndPerformance'
        statusId:
          type: integer
        listMemberId:
          type: integer
        participating:
          type:
          - boolean
          - 'null'
        completed:
          type: boolean
        upvotes:
          type: integer
        downvotes:
          type: integer
        totalVotes:
          type: integer
        netVotes:
          type: integer
        optedIn:
          type: boolean
        optedInDate:
          type: string
          format: date-time
        conversationCount:
          type: integer
        unreadConversationCount:
          type: integer
        hasConversations:
          type: boolean
        postedAt:
          type: string
          format: date-time
        engagements:
          type: integer
        dueDate:
          type: string
          format: date
        assessments:
          type: array
          items:
            type: object
            properties:
              approves:
                type: boolean
              assessorName:
                type: string
              assessorEmail:
                type: string
              createdAt:
                format: date-time
                type: string
                description: The date and time that the assessment was created.
              administrator:
                $ref: '#/components/schemas/AdministratorDeprecated'
        applicationQuestionResponses:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
        applicationProposal:
          type: object
          properties:
            concept:
              type: string
            quote:
              type: number
              format: double
        draftContent:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              contentType:
                type: string
              createdAt:
                format: date-time
                type: string
              comments:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    commenterName:
                      type: string
        activations:
          type: array
          items:
            $ref: '#/components/schemas/ActivationDeprecated'
        instagramPosts:
          type: array
          items:
            type: object
            properties:
              link:
                type: string
              imageUrl:
                type: string
        commentsCount:
          type: integer
        hasNotViewed:
          type: boolean
    PreviewPostDeprecated:
      type: object
      properties:
        id:
          type: integer
        postId:
          type: string
        network:
          type: string
        likes:
          type: integer
        comments:
          type: integer
        views:
          type: integer
        shares:
          type: integer
        caption:
          type: string
        imageUrl:
          type: string
        link:
          type: string
        isSponsored:
          type: boolean
        mentions:
          type: array
          items:
            type: string
        activation:
          $ref: '#/components/schemas/ActivationDeprecated'
        postedTime:
          type: string
          format: date-time
        visualSafeSearch:
          $ref: '#/components/schemas/VisualSafeSearchDeprecated'
        textSafeSearch:
          $ref: '#/components/schemas/TextSafeSearchDeprecated'
    ReviewFormResponseDeprecated:
      type: object
      properties:
        globalUserId:
          type: integer
        membershipId:
          type: integer
          description: Unique Identifier for the membership
        rating:
          type: integer
          description: Review rating
        reviewCharacterCount:
          type: integer
          description: Sum of the character count in the review
        fullName:
          type: string
          description: Name of the influencer
        profilePic:
          type: string
          description: Profile picture of the influencer
        questionResponses:
          type: array
          items:
            $ref: '#/components/schemas/QuestionResponseDeprecated'
        createdAt:
          type: string
          format: date-time
        reviewForm:
          $ref: '#/components/schemas/ReviewFormDeprecated'
        product:
          $ref: '#/components/schemas/ProductDeprecated'
    ReviewFormDeprecated:
      type: object
      required:
      - questions
      properties:
        id:
          type: integer
          description: id of form
        reviewProductId:
          type: integer
        action:
          $ref: '#/components/schemas/ActionDeprecated'
        product:
          $ref: '#/components/schemas/ProductDeprecated'
        questions:
          type: array
          description: Array of form questions
          items:
            $ref: '#/components/schemas/QuestionDeprecated'
        title:
          type: string
        description:
          type: string
        url:
          type: string
        incentivized:
          x-access:
          - administrator
          - root
          type: boolean
          description: whether the form is incentivized
        responses:
          type: array
          x-access:
          - administrator
          - root
          items:
            type: object
            properties:
              membership:
                $ref: '#/components/schemas/MembershipDeprecated'
              questionResponses:
                type: array
                items:
                  type: object
    MetaInformationDeprecated:
      type: object
      description: This information is pulled when an external network parses the link for meta tags.
      properties:
        title:
          type: string
        description:
          type: string
        image:
          type: string
        ftcHashtag:
          type: string
    TextSafeSearchDeprecated:
      type: object
      properties:
        profanityWordCount:
          type: integer
    ListDeliverable:
      properties:
        contentType:
          $ref: '#/components/schemas/NetworkSlug'
        contentTypeName:
          $ref: '#/components/schemas/NetworkName'
        count:
          type: number
          format: double
        id:
          type: number
          format: double
        listId:
          type: number
          format: double
        updatedBy:
          type: number
          format: double
      required:
      - contentType
      - contentTypeName
      - count
      - id
      - listId
      type: object
      additionalProperties: false
    IncentiveClaimDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the incentive claim.
        membershipId:
          type: integer
          x-access:
          - administrator
          - root
        globalUserId:
          type: integer
          x-access:
          - administrator
          - root
        promocode:
          type: string
          description: The issuance of a promo code. This is derived either from a static promo code configured as a property of the incentive resource or dynamically from a uploaded list of codes.
        createdAt:
          format: date-time
          type: string
        profilePictureLink:
          type: string
          x-access:
          - administrator
          - root
        firstName:
          type: string
          x-access:
          - administrator
          - root
        lastName:
          type: string
          x-access:
          - administrator
          - root
        email:
          type: string
          x-access:
          - administrator
          - root
        address:
          type: string
          x-access:
          - administrator
          - root
        age:
          type: integer
          x-access:
          - administrator
          - root
        gender:
          type: string
          x-access:
          - administrator
          - root
        facebookFriendCount:
          type: integer
          x-access:
          - administrator
          - root
        mostRecentRewardFulfilledAt:
          type: string
          format: date-time
          x-access:
          - administrator
          - root
        engagementCount:
          type: integer
        clickCount:
          type: integer
        conversionCount:
          type: integer
    InstagramProfileDeprecated:
      type: object
      properties:
        accessGrant:
          type: object
          properties:
            isExpired:
              type: boolean
            type:
              type: string
              enum:
              - basic
              - business
        averageComments:
          type: integer
        averageEngagements:
          type: integer
        averageLikes:
          type: integer
        audienceFakeCommentersLevel:
          type: string
        audienceFakeCommentersPercentage:
          type: number
        audienceFakeEngagersLevel:
          type: string
        audienceFakeFollowersLevel:
          type: string
        audienceFakeFollowersPercentage:
          type: number
        audienceFakeLikersLevel:
          type: string
        audienceFakeLikersPercentage:
          type: number
        audienceFraudLevel:
          type: string
        audiencePercentageFemale:
          type: number
        audiencePercentage_13_17:
          type: number
        audiencePercentage_18_24:
          type: number
        audiencePercentage_25_34:
          type: number
        audiencePercentage_35_44:
          type: number
        audiencePercentage_45_54:
          type: number
        audiencePercentage_55_64:
          type: number
        audiencePercentage_65_plus:
          type: number
        audiencePredominantAgeRange:
          type: string
        audiencePredominantCity:
          type: string
        audiencePredominantCountry:
          type: string
        bio:
          type: string
        boughtFollowers:
          type: boolean
        engagementRate:
          type: number
        id:
          type: integer
        isBusiness:
          type: boolean
        isPrivate:
          type: boolean
        followersCount:
          type: integer
        followingCount:
          type: integer
        fullName:
          type: string
        handle:
          type: string
        mediaCount:
          type: integer
        nudityLevel:
          type: string
        profanityLevel:
          type: string
        profilePicture:
          type: string
        profileType:
          type: string
          enum:
          - business
          - platform
        sponsoredPostRate:
          type: number
        website:
          type: string
    QuestionResponseDeprecated:
      type: object
      properties:
        question:
          $ref: '#/components/schemas/QuestionDeprecated'
        value:
          type: string
          description: review question value
    ActivationURI:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          description: Unique identifier representing the activation.
        incentive:
          $ref: '#/components/schemas/IncentiveDeprecated'
        points:
          type: number
          description: The number of points earned after activating.
    GlobalUserDeprecated:
      type: object
      properties:
        id:
          type:
          - integer
          - string
        fullName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        profilePicture:
          type: string
        unverified:
          type: string
          enum:
          - hidden
          - emails
          - excludes
        country:
          type: string
          enum:
          - Afghanistan
          - Albania
          - Algeria
          - American Samoa
          - Andorra
          - Angola
          - Anguilla
          - Antarctica
          - Antigua and Barbuda
          - Argentina
          - Armenia
          - Aruba
          - Australia
          - Austria
          - Azerbaijan
          - Bahrain
          - Bangladesh
          - Barbados
          - Belarus
          - Belgium
          - Belize
          - Benin
          - Bermuda
          - Bhutan
          - Bolivia
          - Bosnia and Herzegovina
          - Botswana
          - Bouvet Island
          - Brazil
          - British Indian Ocean Territory
          - British Virgin Islands
          - Brunei
          - Bulgaria
          - Burkina Faso
          - Burundi
          - Cambodia
          - Cameroon
          - Canada
          - Cape Verde
          - Caribbean Netherlands
          - Cayman Islands
          - Central African Republic
          - Chad
          - Chile
          - China
          - Christmas Island
          - Cocos (Keeling) Islands
          - Collectivity of Saint Martin
          - Colombia
          - Comoros
          - Cook Islands
          - Costa Rica
          - Côte d'Ivoire
          - Croatia
          - Cuba
          - Curaçao
          - Cyprus
          - Czechia
          - Democratic Republic of the Congo
          - Denmark
          - Djibouti
          - Dominica
          - Dominican Republic
          - Ecuador
          - Egypt
          - El Salvador
          - Equatorial Guinea
          - Eritrea
          - Estonia
          - Ethiopia
          - Falkland Islands (Malvinas)
          - Faroe Islands
          - Federated States of Micronesia
          - Fiji
          - Finland
          - France
          - French Guiana
          - French Polynesia
          - French Southern Territories
          - Gabon
          - Georgia
          - Germany
          - Ghana
          - Gibraltar
          - Greece
          - Greenland
          - Grenada
          - Guadeloupe
          - Guam
          - Guatemala
          - Guernsey
          - Guinea
          - Guinea-Bissau
          - Guyana
          - Haiti
          - Heard Island and McDonald Islands
          - Holy See (Vatican City)
          - Honduras
          - Hong Kong
          - Hungary
          - Iceland
          - India
          - Indonesia
          - Iran
          - Iraq
          - Ireland
          - Isle of Man
          - Israel
          - Jamaica
          - Japan
          - Italy
          - Jersey
          - Jordan
          - Kazakhstan
          - Kenya
          - Kiribati
          - Kuwait
          - Kyrgyzstan
          - Laos
          - Latvia
          - Lebanon
          - Lesotho
          - Liberia
          - Libya
          - Liechtenstein
          - Lithuania
          - Luxembourg
          - Macau
          - Macedonia (FYROM)
          - Madagascar
          - Malawi
          - Malaysia
          - Maldives
          - Mali
          - Malta
          - Marshall Islands
          - Martinique
          - Mauritania
          - Mauritius
          - Mayotte
          - Mexico
          - Moldova
          - Monaco
          - Mongolia
          - Montenegro
          - Montserrat
          - Morocco
          - Mozambique
          - Myanmar (Burma)
          - Namibia
          - Nauru
          - Nepal
          - Netherlands
          - New Caledonia
          - New Zealand
          - Nicaragua
          - Niger
          - Nigeria
          - Niue
          - Norfolk Island
          - North Korea
          - Northern Mariana Islands
          - Norway
          - Oman
          - Pakistan
          - Palau
          - Palestine
          - Panama
          - Papua New Guinea
          - Paraguay
          - Peru
          - Philippines
          - Pitcairn
          - Poland
          - Portugal
          - Puerto Rico
          - Qatar
          - Republic of the Congo
          - Reunion
          - Romania
          - Russia
          - Rwanda
          - Saint Helena, Ascension and Tristan da Cunha
          - Saint Kitts and Nevis
          - Saint Lucia
          - Saint Pierre and Miquelon
          - Saint Vincent and the Grenadines
          - Saint-Barthélemy
          - Samoa
          - San Marino
          - Sao Tome and Principe
          - Saudi Arabia
          - Senegal
          - Serbia
          - Seychelles
          - Sierra Leone
          - Singapore
          - Sint Maarten (Dutch part)
          - Slovakia
          - Slovenia
          - Solomon Islands
          - Somalia
          - South Africa
          - South Georgia and the South Sandwich Islands
          - South Korea
          - South Sudan
          - Spain
          - Sri Lanka
          - Sudan
          - Suriname
          - Svalbard and Jan Mayen
          - Swaziland
          - Sweden
          - Switzerland
          - Syria
          - Taiwan
          - Tajikistan
          - Tanzania
          - Thailand
          - The Bahamas
          - The Gambia
          - Timor-Leste
          - Togo
          - Tokelau
          - Tonga
          - Trinidad and Tobago
          - Tunisia
          - Turkey
          - Turkmenistan
          - Turks and Caicos Islands
          - Tuvalu
          - U.S. Virgin Islands
          - Uganda
          - Ukraine
          - United Arab Emirates
          - United Kingdom
          - United States Minor Outlying Islands
          - United States
          - Uruguay
          - Uzbekistan
          - Vanuatu
          - Venezuela
          - Vietnam
          - Wallis and Futuna
          - Western Sahara
          - Yemen
          - Zambia
          - Zimbabwe
          - Åland Islands
        state:
          type: string
        city:
          type: string
        zip:
          type: string
        street:
          type: string
        apt:
          type: string
        phone:
          type: string
        age:
          type: integer
        gender:
          type: string
          enum:
          - male
          - female
          - other
          - non_bin
          - describe
        email:
          type: string
        talentManagerEmail:
          type: string
        registered:
          type: boolean
        birthday:
          type: string
          format: date
        facebookProfile:
          $ref: '#/components/schemas/FacebookProfileDeprecated'
        instagramAccount:
          $ref: '#/components/schemas/InstagramAccountDeprecated'
        instagramProfile:
          $ref: '#/components/schemas/InstagramProfileDeprecated'
        tiktokCreator:
          $ref: '#/components/schemas/TikTokCreatorDeprecated'
        twitterAccount:
          $ref: '#/components/schemas/TwitterAccountDeprecated'
        pinterestAccount:
          $ref: '#/components/schemas/PinterestAccountDeprecated'
        youtubeChannel:
          $ref: '#/components/schemas/YoutubeChannelDeprecated'
        blog:
          $ref: '#/components/schemas/Blog'
        lists:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              label:
                type: string
        appMembership:
          $ref: '#/components/schemas/MembershipDeprecated'
        userContactInfo:
          type: object
          properties:
            updatedAt:
              type: string
              format: date-time
            emailIsVerified:
              type: boolean
            referralSlug:
              type: string
            referralCount:
              type: string
            gender:
              type: string
            genderDescription:
              type: string
        influencerTopics:
          type: array
          items:
            $ref: '#/components/schemas/TopicDeprecated'
        previewPosts:
          type: array
          items:
            $ref: '#/components/schemas/PreviewPostDeprecated'
        activations:
          type: integer
        engagements:
          type: integer
        clicksCount:
          type: integer
        conversionCount:
          type: integer
        conversionValue:
          type: number
          format: double
        rewards:
          type: integer
        facebookPostsCount:
          type: integer
        instagramPostsCount:
          type: integer
        twitterPostsCount:
          type: integer
        pinterestPostsCount:
          type: integer
        membershipDataPoints:
          type: array
          items:
            type: object
            properties:
              dataPointDefinition:
                $ref: '#/components/schemas/DataPointDefinitionDeprecated'
              lastEditedBy:
                type: string
              updatedAt:
                type: string
                format: date-time
              value:
                type: array
                items:
                  type: string
        membershipCostAndPerformance:
          $ref: '#/components/schemas/MembershipCostAndPerformanceDeprecated'
        audiencePredominantAgeRange:
          type: string
        audiencePredominantCountry:
          type: string


# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-listmember-api-openapi.yml