Mavrck List Member Reward Win API
The ListMemberRewardWin API from Mavrck — 6 operation(s) for listmemberrewardwin.
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 Reward Win API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: ListMemberRewardWin
paths:
/list-member-reward-wins/{listMemberRewardWinId}:
get:
tags:
- ListMemberRewardWin
operationId: getListMemberRewardWin
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Gets a list member reward win.
parameters:
- name: listMemberRewardWinId
in: path
description: ID of list member reward win
required: true
schema:
type: integer
responses:
'200':
description: An individual list member reward win
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemberRewardWin'
'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: Message not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
tags:
- ListMemberRewardWin
operationId: updateRewardWin
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Update the List Member Reward Win.
parameters:
- name: listMemberRewardWinId
in: path
required: true
schema:
type: integer
responses:
'200':
description: List Member Reward Win updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemberRewardWin'
'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: Message 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:
$ref: '#/components/schemas/ListMemberRewardWin'
required: true
/list-member-reward-win/bulk-fulfill/options/reward-wins:
post:
tags:
- ListMemberRewardWin
operationId: getRewardWinsForBulkFulfillment
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Get all reward wins for bulk fulfillment confirmation based on option selection
responses:
'200':
description: An array of reward wins bulk fulfillment based on the selected option.
content:
application/json:
schema:
type: object
properties:
meta:
type: object
properties:
limit:
type: integer
offset:
type: integer
totalCount:
type: integer
paymentAccountType:
type: string
paymentAccountBalance:
type: number
paymentAccountProvider:
type: string
paymentAccountId:
type: number
data:
type: array
items:
type: object
properties:
id:
type: integer
value:
type:
- number
- 'null'
cost:
type:
- number
- 'null'
valueCurrencyCode:
type: string
costCurrencyCode:
type: string
bonusTierCurrencyCode:
type:
- string
- 'null'
bonusTiers:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BonusTier'
attainedBonusTierIndex:
type:
- integer
- 'null'
type:
type: string
displayType:
type: string
rewardTitle:
type: string
displayName:
type: string
isSelected:
type: boolean
globalUserId:
type: number
listMemberId:
type: number
discountCodeId:
type: string
incentiveId:
type: number
taxLineItems:
type:
- array
- 'null'
items:
type: object
properties:
type:
type: string
amount:
type: number
'400':
description: Invalid parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Session expired.
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
required:
- actionGroupId
properties:
paymentAccountId:
type: integer
globalUserIds:
type: array
items:
type: integer
actionGroupId:
type: integer
queryFilter:
$ref: '#/components/schemas/ActionGroupCandidateQueryFilter'
required: true
/list-member-reward-win/bulk-fulfill/options:
post:
tags:
- ListMemberRewardWin
operationId: getBulkFulfillOptions
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Get all bulk fulfillment options for a selection of influencers, combine all offline options into one option
responses:
'200':
description: An array of options for bulk fulfillment.
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/BulkFulfillOption'
'400':
description: Invalid parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Session expired.
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
required:
- actionGroupId
properties:
globalUserIds:
type: array
items:
type: integer
actionGroupId:
type: integer
description: Unique identifier of the actionGroup
queryFilter:
$ref: '#/components/schemas/ActionGroupCandidateQueryFilter'
required: true
/list-member-reward-win/bulk-fulfill/options-all:
post:
tags:
- ListMemberRewardWin
operationId: getAllBulkFulfillOptions
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Get all bulk fulfillment options for a selection of influencers, splitting all offline options into their own options
responses:
'200':
description: An array of options for bulk fulfillment.
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/BulkFulfillOption'
'400':
description: Invalid parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Session expired.
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
required:
- actionGroupId
properties:
globalUserIds:
type: array
items:
type: integer
actionGroupId:
type: integer
description: Unique identifier of the actionGroup
queryFilter:
$ref: '#/components/schemas/ActionGroupCandidateQueryFilter'
required: true
/list-member-reward-wins/enriched:
get:
tags:
- ListMemberRewardWin
x-handler: reward_wins/list_member_reward_win/list_member_reward_win_controller.js
x-access:
- administrator
summary: Get enriched list member reward win data by incentive ids. Expects comma-separated string representations of an array of integers.
operationId: getEnrichedListMemberRewardWins
parameters:
- name: rewardWinIds
in: query
required: false
schema:
type: string
- name: cashPaymentIds
in: query
schema:
type: string
responses:
'200':
description: An array of list members with their list member reward wins
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/EnrichedListMemberRewardWin'
'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: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/action-groups/{actionGroupId}/list-member-reward-wins/{globalUserId}:
get:
operationId: getRewardWins
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetListMemberRewardWinResponse'
'400':
description: Missing Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: The resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ListMemberRewardWin
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
- in: path
name: globalUserId
required: true
schema:
type: number
format: double
- in: query
name: includeMostRecentTransaction
required: false
schema:
type: boolean
post:
operationId: createRewardWin
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemberRewardWinResponse'
'400':
description: Missing Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: The resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ListMemberRewardWin
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
- in: path
name: globalUserId
required: true
schema:
type: number
format: double
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListMemberRewardWinRequestBody'
required: true
components:
schemas:
AudienceDeprecated:
type: object
x-access:
- root
- administrator
properties:
id:
type: integer
description: Unique identifier representing a single audience.
name:
type: string
description: Human-readable description of the audience displayed to administrators.
criteria:
type: array
items:
$ref: '#/components/schemas/InfluencerDataPointCriteriaDeprecated'
GetRewardWinListMemberRewardWin:
$ref: '#/components/schemas/Pick_ListMemberRewardWin.id-or-listMemberId-or-eligibleOnEventType_'
ProductDeprecated:
type: object
properties:
id:
type: integer
description: id of the product
title:
type: string
description: title of the product
description:
type: string
description: Description of product
image:
type: string
description: product image url
communityId:
type: string
description: instance to which this product belongs
bazaarVoiceAppProduct:
$ref: '#/components/schemas/BazaarVoiceAppProductDeprecated'
powerReviewsPage:
$ref: '#/components/schemas/PowerReviewsPageDeprecated'
yotpoAppProduct:
$ref: '#/components/schemas/YotpoAppProductDeprecated'
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
PendingActivationURI:
type: object
properties:
id:
type: integer
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.
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
TaxLineItem:
properties:
amount:
type: number
format: double
type:
$ref: '#/components/schemas/TaxLineItemType'
required:
- amount
- type
type: object
RoutingOptionsDeprecated:
type: object
description: Routing options
properties:
redirect_url:
type: string
description: Url the influencer should be redirected to.
cta:
type: string
description: Displayed CTA.
mode:
type: string
description: Routing type.
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
InstagramAccountDeprecated:
type: object
properties:
id:
description: int = mavck-db-id, string = derived-index-id
type:
- integer
- string
handle:
type: string
fullName:
type: string
profilePicture:
type: string
bio:
type: string
website:
type: string
followersCount:
type: integer
followingCount:
type: integer
mediaCount:
type: integer
averageLikes:
type: integer
averageComments:
type: integer
averageEngagements:
type: integer
engagementRate:
type: number
isBusiness:
type: boolean
isPrivate:
type: boolean
sponsoredPostRate:
type: number
primaryAccount:
type: boolean
profileType:
type: string
enum:
- platform
- business
instagramAccessGrant:
type: object
properties:
isExpired:
type: boolean
platformIsExpired:
type: boolean
businessIsExpired:
type: boolean
DBRewardWinType:
enum:
- OTHER
- CASH
- PRODUCT
- PROMO_CODE
- GIFT_CARD
- SHOPIFY_DISCOUNT
type: string
Pick_ListMemberRewardWin.id-or-listMemberId-or-eligibleOnEventType_:
properties:
id:
type: number
format: double
listMemberId:
type: number
format: double
eligibleOnEventType:
$ref: '#/components/schemas/EventType'
required:
- id
- listMemberId
type: object
description: From T, pick a set of properties whose keys are in the union K
ActionGroupDeprecated:
type: object
properties:
id:
type: integer
description: Unique identifier representing a single action group.
communityId:
type: string
communityName:
type: string
communityImage:
type: string
type:
type: string
mainType:
type: string
description: First action in the group type
name:
type: string
description: Human-readable description of the action group displayed for administrators.
x-access:
- root
- administrator
title:
type: string
description:
type: string
image:
type: string
contentType:
type: string
description: For content action groups, this provides the type of content, which either matches og:image or is derived from internal heuristics.
url:
type: string
description: For content action groups, this contains the url input upon creation.
status:
type: string
description: The state of the action group. One of the set {"LIVE", "PAUSED", "PENDING", "EXPIRED"}.
x-access:
- root
- administrator
startDate:
format: date-time
type: string
description: The scheduled time in which the action group will become available to influencers.
endDate:
format: date-time
type:
- 'null'
- string
description: The scheduled time in which the action group will no longer be available to influencers.
createdAt:
format: date-time
type:
- 'null'
- string
notInCommunity:
type: boolean
x-access:
- root
- administrator
description: Filter this action group if the client specifies channel=community.
isAutoCreated:
type: boolean
isPrimaryReferralActivity:
type: boolean
multipleActivations:
type: boolean
description: Indicates whether this action group can be completed multiple times. Only available for photoChallenge.
campaign:
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'
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.
audience:
$ref: '#/components/schemas/AudienceDeprecated'
incentive:
$ref: '#/components/schemas/IncentiveDeprecated'
incentives:
items:
$ref: '#/components/schemas/IncentiveDeprecated'
type: array
actions:
items:
$ref: '#/components/schemas/ActionDeprecated'
type: array
points:
type: object
properties:
min:
type: integer
max:
type: integer
hasScheduledNotifications:
type: boolean
description: Indicates whether the action group is tied to any scheduled notifications. The audience cannot be modified if this is the case.
listId:
type: integer
listDeliverables:
type: array
items:
$ref: '#/components/schemas/ListDeliverable'
influencerReviewDeliverable:
type: object
properties:
id:
type: integer
count:
type: integer
listId:
type: integer
workflowStatuses:
type: array
items:
$ref: '#/components/schemas/ListCustomStatusDeprecated'
locale:
type: string
description: Formatted according to language codes (https://www.w3schools.com/tags/ref_language_codes.asp)
activatedUsersMetrics:
type: integer
clicksMetrics:
type: integer
engagementsMetrics:
type: integer
impressionsMetrics:
type: integer
conversionsCountMetrics:
type: integer
conversionsValueMetrics:
type: number
posts:
type: integer
engagements:
type: integer
impressions:
type: integer
cpe:
type: number
cpp:
type: number
cpm:
type: number
cpa:
type: number
committedAmount:
type: number
paidAmount:
type: number
readyAmount:
type: number
cost:
type: number
roiValue:
type: number
workflowSummary:
type: object
properties:
accepted:
type: integer
rejected:
type: integer
candidates:
type: integer
applicants:
type: integer
participants:
type: integer
completed:
type: integer
requiredHashtag:
type: string
description: Hashtag for action group (required)
ftcHashtag:
type: string
description: FTC hashtag for an action group.
youtubeHashtag:
type: string
description: YouTube hashtag for an action group.
internalDescription:
type: string
description: Internal description on an action group.
activityBudget:
type:
- 'null'
- number
description: Total budget for all actions under an action group.
numberOfInfluencers:
type:
- 'null'
- integer
description: Target number of influencers for all actions under an action group.
cpeGoal:
type:
- number
- 'null'
description: Cost per engagement goal for a single action group
cpmGoal:
type:
- number
- 'null'
description: Cost per 1000 impressions goal for a single action group
impressionsGoal:
type:
- number
- 'null'
description: Impressions goal for a single action group
engagementsGoal:
type:
- number
- 'null'
description: Engagements goal for a single action group
engagementRateGoal:
type:
- number
- 'null'
description: Engagement rate goal for a single action group
contentDueDate:
type:
- string
- 'null'
description: Due date for content on an action group.
draftDueDate:
type:
- string
- 'null'
description: Due date for drafts on an action group.
conceptDueDate:
type:
- string
- 'null'
description: Due date for concepts on an action group.
primaryNetwork:
type: string
hasPointsEnabled:
type: boolean
shareableReportLink:
type: string
termsOfServiceLink:
type: string
autoAcceptApplicant:
type: boolean
globalUserListDefinitionId:
type:
- integer
- 'null'
ready:
type: number
pending:
type: number
fulfilled:
type: number
brief:
type: string
hideOnIcm:
type: boolean
application:
type: object
properties:
requestBrandedContentPermission:
type: boolean
community:
type: object
properties:
instagramHandle:
type: string
isSetupEnabled:
type: boolean
isCopied:
type: boolean
hideTemplateUpdateCTA:
type: boolean
isLaterCreatorExperienceEnabled:
type: boolean
isMavelyCreatorExperienceEnabled:
type: boolean
budgetReferenceId:
type:
-
# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-listmemberrewardwin-api-openapi.yml