Mavrck List Member API
The ListMember API from Mavrck — 2 operation(s) for listmember.
OpenAPI Specification
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:
Error:
type: object
properties:
type:
type: string
description: A key representing the type of error that has occurred.
error:
type: string
description: A static description of the type of error.
params:
type: array
description: For errors invovling parameters, this is an array containing the invalid parameters.
items:
type: string
keys:
type: array
items:
type:
- string
- object
artifactLinks:
$ref: '#/components/schemas/LinksDeprecated'
parent:
type: object
properties:
type:
type: string
description: A key representing the type of error generated by a request to an external API.
error:
type: string
description: A static description of the parent error.
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
BonusTier:
description: 'Swagger 2 representation of a tiered bonus entry.
`upperBound` is required for `BOUNDED` tiers and must be omitted for
`OPEN_ENDED` tiers. The bonus-tier validator enforces that conditional rule.
Validation rules:
- `bonusTiers` may contain at most 5 tiers.
- Tiers must be sorted by `lowerBound`.
- Adjacent tiers must be contiguous.
- The final tier must be `OPEN_ENDED`.
- `bonusTierCurrencyCode` is required when `bonusTiers` is non-empty.'
properties:
type:
type: string
enum:
- BOUNDED
- OPEN_ENDED
lowerBound:
type: number
format: double
description: Inclusive lower conversion/order bound for this payout tier. Must be non-negative.
upperBound:
type: number
format: double
description: Exclusive upper conversion/order bound for a `BOUNDED` tier.
bonusAmount:
type: number
format: double
description: Bonus payout amount in `bonusTierCurrencyCode`. Must be positive.
required:
- type
- lowerBound
- bonusAmount
type: object
additionalProperties: false
WorkflowStatusRequirementDeprecated:
type: object
properties:
satisfied:
type: boolean
incentiveId:
type: number
name:
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
items:
type:
- integer
- string
DemographicsPro_Audience_PeopleInfluences_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_MediaInfluences_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_BrandInfluences_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_Favorite_MusicGenre_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_Favorite_MusicSoloArtist_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_Favorite_MusicBands_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_SportsFollowed_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_SportTeamSupported_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_BrandInfluences_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Country_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Gender_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Age_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Race_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Language_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Data_Analysis_Facebook:
type: object
additionalProperties: false
properties:
DemographicsPro_Audience_Gender_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_City_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_Data_Analysis_TikTok:
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
items:
type:
- integer
- string
DemographicsPro_Audience_PeopleInfluences_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_MediaInfluences_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_BrandInfluences_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_Favorite_MusicGenre_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_Favorite_MusicSoloArtist_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_Favorite_MusicBands_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_SportsFollowed_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_SportTeamSupported_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_Gender_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
type:
- integer
- string
range:
type: object
additionalProperties: false
properties:
$gte:
type: number
$lte:
type: number
DemographicsPro_Audience_Age_All:
type: object
additionalProperties: false
x-filter-type: multiTerm
properties:
ids:
type: array
items:
# --- 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