Mavrck Action Group Custom Statuses API
The ActionGroupCustomStatuses API from Mavrck — 5 operation(s) for actiongroupcustomstatuses.
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 Action Group Custom Statuses API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: ActionGroupCustomStatuses
paths:
/action-groups/{actionGroupId}/bulk-assign-custom-statuses:
post:
tags:
- ActionGroupCustomStatuses
x-handler: list_custom_statuses/action_group_custom_status_bulk_application_controller.js
x-access:
- administrator
operationId: bulkAssignActionGroupCustomStatuses
summary: Assign an action group custom status to candidates in bulk.
parameters:
- name: actionGroupId
in: path
required: true
schema:
type: integer
responses:
'200':
description: Custom status assigned 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: Action group 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
required:
- customStatusId
properties:
customStatusId:
type:
- integer
- 'null'
globalUserIds:
type: array
items:
type: integer
queryFilter:
$ref: '#/components/schemas/ActionGroupCandidateQueryFilter'
required: true
/v1/action-groups/{actionGroupId}/custom-statuses:
get:
operationId: getTrackingStatuses
responses:
'200':
description: A collection of tracking statuses
content:
application/json:
schema:
$ref: '#/components/schemas/ActionGroupCustomStatusesGetResponse'
'400':
description: Invalid Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Action group not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ActionGroupCustomStatuses
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
- in: query
name: all
required: false
schema:
type: boolean
post:
operationId: createTrackingStatus
responses:
'200':
description: Tracking status created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TSOAEmptyObject'
'400':
description: Invalid Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Action group not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ActionGroupCustomStatuses
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomStatus'
required: true
/v1/action-groups/{actionGroupId}/custom-statuses/{id}/reorder:
put:
operationId: reorderTrackingStatus
responses:
'200':
description: Action group custom status updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TSOAEmptyObject'
'400':
description: Invalid Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Action group not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ActionGroupCustomStatuses
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
- in: path
name: id
required: true
schema:
type: number
format: double
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomStatus'
required: true
/v1/action-groups/{actionGroupId}/custom-statuses/{id}:
put:
operationId: updateTrackingStatus
responses:
'200':
description: Action group custom status updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TSOAEmptyObject'
'400':
description: Invalid Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Action group not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ActionGroupCustomStatuses
parameters:
- in: path
name: actionGroupId
required: true
schema:
type: number
format: double
- in: path
name: id
required: true
schema:
type: number
format: double
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Partial_ListCustomStatus_'
required: true
/v1/action-groups/custom-statuses/{id}/delete:
delete:
operationId: deleteTrackingStatus
responses:
'200':
description: Action group custom status deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ActionGroupCustomStatusDeleteResponse'
'400':
description: Invalid Parameter
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateErrorJSON'
'403':
description: Access forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Action group not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ServerError'
tags:
- ActionGroupCustomStatuses
parameters:
- in: path
name: id
required: true
schema:
type: number
format: double
components:
schemas:
Administrator:
properties:
id:
type: number
format: double
email:
type: string
first_name:
type: string
last_name:
type:
- string
- 'null'
image:
type:
- string
- 'null'
approves:
type: boolean
createdAt:
type: string
type: object
additionalProperties: false
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
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.
Partial_ListCustomStatus_:
properties:
actionGroupId:
type: number
format: double
auxiliaryLabel:
type: string
ctaLabel:
type: string
custom:
type: boolean
disabled:
type: boolean
enabled:
type: boolean
id:
type: number
format: double
label:
type: string
linkedStages:
items:
type: string
type: array
phase:
type: string
slug:
type: string
statusOrder:
type: number
format: double
templates:
items:
$ref: '#/components/schemas/ConversationTemplate'
type: array
type: object
description: Make all properties in T optional
TSOAEmptyObject:
properties: {}
type: object
additionalProperties: false
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
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-actiongroupcustomstatuses-api-openapi.yml