Later 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:
  parameters:
    orderByParam:
      in: query
      description: Attribute to order by.
      name: orderBy
      schema:
        type: string
    orderDirection:
      in: query
      description: Select the direction by which the data will be ordered, ascending or descending.
      name: orderDirection
      schema:
        type: string
        enum:
        - ASC
        - DESC
  schemas:
    CampaignDeprecated:
      type: object
      x-access:
      - root
      - administrator
      properties:
        id:
          type: integer
          description: Unique identifier representing a single campaign.
        name:
          type: string
          description: Name of campaign.
        description:
          type: string
          description: Name of campaign.
        brand:
          $ref: '#/components/schemas/BrandDeprecated'
        actionGroups:
          type: array
          description: The action groups for this campaign.
          items:
            $ref: '#/components/schemas/ActionGroupDeprecated'
        hasActivations:
          type: boolean
          description: Flag that indicates whether this campaign is associated with any activations.
        createdAt:
          format: date-time
          type: string
          description: The date and time that the campaign was created.
    WorkflowStatusRequirementDeprecated:
      type: object
      properties:
        satisfied:
          type: boolean
        incentiveId:
          type: number
        name:
          type: string
    PinterestAccountDeprecated:
      type: object
      properties:
        id:
          description: int = mavck-db-id, string = derived-index-id
          type:
          - integer
          - string
        username:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        profilePicture:
          type: string
        bio:
          type: string
        followersCount:
          type: integer
        followingCount:
          type: integer
        monthlyViewers:
          type: integer
        averageEngagements:
          type: integer
        engagementRate:
          type: number
        boardsCount:
          type: integer
        pinsCount:
          type: integer
        pinterestAccessGrant:
          type: object
          properties:
            isExpired:
              type: boolean
        primaryAccount:
          type: boolean
    ActivationDeprecated:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier representing a single activation.
        externalId:
          type: string
          description: Instagram external id
        profilePicture:
          type: string
          description: Link to the user's Facebook profile picture using the External Facebook id of the user who created this activation.
        membershipId:
          type: integer
          description: Community membership id of user who created this activation used that can be used for pulling up influencer profiles.
        globalUserId:
          type: integer
        createdByAccountId:
          type: string
          description: Id of self-service application user who manually bound or manually entered this activation
        updatedByAccountId:
          type: string
          description: Id of self-service application user who manually updated this activation
        createdAt:
          type: string
          format: date-time
          description: CREATED AT TIME
        approvalStatus:
          type: string
          description: The Approval status of the activation.
        points:
          type: number
          description: Number of points that the activation grants.
        isApproved:
          type: boolean
          x-access:
          - root
          - administrator
          description: Indicates whether this activation has been approved to be publicly available.
        selfReported:
          type: boolean
        user:
          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'
            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
            audiencePredominantCity:
              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
            cpe:
              type: number
            cpm:
              type: number
            cpp:
              type: number
            audienceFraudLevel:
              type: string
              enum:
              - low
              - medium
              - high
            audienceFakeFollowersLevel:
              type: string
              enum:
              - low
              - medium
              - high
            audienceFakeEngagersLevel:
              type: string
              enum:
              - low
              - medium
              - high
            nudityLevel:
              type: string
              enum:
              - low
              - medium
              - high
            violenceLevel:
              type: string
              enum:
              - low
              - medium
              - high
            profanityLevel:
              type: string
              enum:
              - low
              - medium
              - high
            hasPublicSummaryRecord:
              type: boolean
        action:
          $ref: '#/components/schemas/ActionDeprecated'
        content:
          $ref: '#/components/schemas/ActivationContentDeprecated'
        instagramAccount:
          $ref: '#/components/schemas/InstagramAccountDeprecated'
        facebookProfile:
          $ref: '#/components/schemas/FacebookProfileDeprecated'
        twitterAccount:
          $ref: '#/components/schemas/TwitterAccountDeprecated'
        pinterestAccount:
          $ref: '#/components/schemas/PinterestAccountDeprecated'
        contactInfo:
          $ref: '#/components/schemas/MembershipContactInfoDeprecated'
        membership:
          $ref: '#/components/schemas/MembershipDeprecated'
        campaign:
          $ref: '#/components/schemas/CampaignDeprecated'
        surveyResponses:
          type: array
          items:
            $ref: '#/components/schemas/UserQuestionResponse'
        reviewContent:
          $ref: '#/components/schemas/ReviewFormResponseDeprecated'
        validation:
          type: object
          properties:
            ftcStatus:
              type: string
              enum:
              - unknown
              - valid
              - invalid
        brandedContentTagIGHandle:
          type: string
          description: A business partner that an influencer tagged in their Partnership Ads posts.
        tikTokHandle:
          type: string
          description: TikTok username handle
        tikTokMetrics:
          type: object
        tags:
          type: array
          items:
            type: string
        exportFilenames:
          type: array
          items:
            type: string
    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
    YoutubeChannelDeprecated:
      type: object
      properties:
        id:
          description: int = mavck-db-id, string = derived-index-id
          type:
          - integer
          - string
        username:
          type: string
        bio:
          type: string
        primaryAccount:
          type: boolean
        profilePicture:
          type: string
        followersCount:
          type: integer
        youtubeExternalId:
          type: string
        videoCount:
          type: integer
        viewCount:
          type: integer
        commentCount:
          type: integer
        handle:
          type: string
    TikTokCreatorDeprecated:
      type: object
      properties:
        displayName:
          type: string
        followersCount:
          type: integer
        globalUserId:
          type: integer
        handleName:
          type: string
        insightsUpdatedAt:
          type: string
          format: date-time
        isActive:
          type: boolean
        profileImage:
          type: string
        status:
          type: string
        tiktokAccessGrant:
          type: object
        audiencePredominantAgeRange:
          type: string
        audiencePredominantCountry:
          type: string
        audiencePredominantDevice:
          type: string
        audiencePredominantGender:
          type: string
        audiencePredominantLocale:
          type: string
    UserSearch:
      type: object
      additionalProperties: false
      properties:
        DemographicsPro_Audience_Data_Analysis:
          type: object
          additionalProperties: false
          properties:
            DemographicsPro_Audience_Gender_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_MaritalStatus_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_ParentalStatus_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_Age_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_Race_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_Language_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_Country_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_State_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_City_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_EducationStatus_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_PersonalIncome_Max:
              type: array
              x-filter-type: term
              items:
                type: string
            DemographicsPro_Audience_Occupation_Max:
              type: object
              additionalProperties: false
              x-filter-type: multiTerm
              properties:
                quantifier:
                  type: string
                  enum:
                  - any
                  - all
                ids:
                  type: array
                  items:
                    type:
                    - integer
                    - string
            DemographicsPro_Audience_Industry_Max:
              type: object
              additionalProperties: false
              x-filter-type: multiTerm
              properties:
                quantifier:
                  type: string
                  enum:
                  - any
                  - all
                ids:
                  type: array
                  items:
                    type:
                    - integer
                    - string
            DemographicsPro_Audience_Employer_Max:
              type: object
              additionalProperties: false
              x-filter-type: multiTerm
              properties:
                quantifier:
                  type: string
                  enum:
                  - any
                  - all
                ids:
                  type: array
                  items:
                    type:
                    - integer
                    - string
            DemographicsPro_Audience_EducationOrganization_Max:
              type: object
              additionalProperties: false
              x-filter-type: multiTerm
              properties:
                quantifier:
                  type: string
                  enum:
                  - any
                  - all
                ids:
                  type: array
                  items:
                    type:
                    - integer
                    - string
            DemographicsPro_Audience_LikesAndInterests_Max:
              type: object
              additionalProperties: false
              x-filter-type: multiTerm
              properties:
                quantifier:
                  type: string
                  enum:
                  - any
                  - all
                ids:
                  type: array
               

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