How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Extole

Extole Campaign Controllers Actions API

The Campaign Controllers Actions API from Extole — 54 operation(s) for campaign controllers actions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Extole Campaign Controllers Actions API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaign Controllers Actions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 102 operations across 54 paths, and defines 331 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

102 operations 54 paths 331 schemas 23 DELETE32 GET24 POST23 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Campaign Controllers Actions API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 102

Across 54 paths, the API surfaces 102 operations — 23 DELETE, 32 GET, 24 POST, 23 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaign Controllers Actions 102
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions
List all campaign controller actions
listCampaignControllerActions 3 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves/{actionId}
Get an approve action
getApproveAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves/{actionId}
Update an approve action
updateApproveAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves/{actionId}
Delete an approve action
deleteApproveAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards/{actionId}
Get a cancel-reward action
getCancelRewardAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards/{actionId}
Update a cancel-reward action
updateCancelRewardAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards/{actionId}
Delete a cancel-reward action
deleteCancelRewardAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships/{actionId}
Get a create-membership action
getCreateMembershipAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships/{actionId}
Update a create-membership action
updateCreateMembershipAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships/{actionId}
Delete a create-membership action
deleteCreateMembershipAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}
Get a creative action
getCreativeAction 4 params → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}
Upload a creative action archive
uploadCreativeAction 4 params body → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}
Update a creative action
updateCreativeAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}
Delete a creative action
deleteCreativeAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives/{actionId}.zip
Download a creative action archive
downloadCreativeAction 5 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences
List data-intelligence actions
listDataIntelligenceActions 3 params → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences
Create a data-intelligence action
createDataIntelligenceAction 3 params body → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences/{actionId}
Get a data-intelligence action
getDataIntelligenceAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences/{actionId}
Update a data-intelligence action
updateDataIntelligenceAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences/{actionId}
Delete a data-intelligence action
deleteDataIntelligenceAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines/{actionId}
Get a decline action
getDeclineAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines/{actionId}
Update a decline action
updateDeclineAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines/{actionId}
Delete a decline action
deleteDeclineAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards/{actionId}
Get an earn-reward action
getEarnRewardAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards/{actionId}
Update an earn-reward action
updateEarnRewardAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards/{actionId}
Delete an earn-reward action
deleteEarnRewardAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions/{actionId}
Get an expression action
getExpressionAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions/{actionId}
Update an expression action
updateExpressionAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions/{actionId}
Delete an expression action
deleteExpressionAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards/{actionId}
Get a fulfill-reward action
getFulfillRewardAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards/{actionId}
Update a fulfill-reward action
updateFulfillRewardAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards/{actionId}
Delete a fulfill-reward action
deleteFulfillRewardAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards/{actionId}
Get a redeem-reward action
getRedeemRewardAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards/{actionId}
Update a redeem-reward action
updateRedeemRewardAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards/{actionId}
Delete a redeem-reward action
deleteRedeemRewardAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships/{actionId}
Get a remove-membership action
getRemoveMembershipAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships/{actionId}
Update a remove-membership action
updateRemoveMembershipAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships/{actionId}
Delete a remove-membership action
deleteRemoveMembershipAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards/{actionId}
Get a revoke-reward action
getRevokeRewardAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards/{actionId}
Update a revoke-reward action
updateRevokeRewardAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards/{actionId}
Delete a revoke-reward action
deleteRevokeRewardAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules/{actionId}
Get a schedule action
getScheduleAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules/{actionId}
Update a schedule action
updateScheduleAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules/{actionId}
Delete a schedule action
deleteScheduleAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events/{actionId}
Get a share-event action
getShareEventAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events/{actionId}
Update a share-event action
updateShareEventAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events/{actionId}
Delete a share-event action
deleteShareEventAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1/{actionId}
Get a signal-v1 action
getSignalV1Action 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1/{actionId}
Update a signal-v1 action
updateSignalV1Action 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1/{actionId}
Delete a signal-v1 action
deleteSignalV1Action 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals/{actionId}
Get a signal action
getSignalAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals/{actionId}
Update a signal action
updateSignalAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals/{actionId}
Delete a signal action
deleteSignalAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals/{actionId}
Get a step-signal action
getStepSignalAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals/{actionId}
Update a step-signal action
updateStepSignalAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals/{actionId}
Delete a step-signal action
deleteStepSignalAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks/{actionId}
Get a webhook action
getWebhookAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks/{actionId}
Update a webhook action
updateWebhookAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks/{actionId}
Delete a webhook action
deleteWebhookAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/{actionId}
Get a campaign controller action
getCampaignControllerAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}
Get a display action
getDisplayAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}
Update a display action
updateDisplayAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}
Delete a display action
deleteDisplayAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays/{actionId}/built
Get the built display action
getBuiltDisplayAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}
Get an email action
getEmailAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}
Update an email action
updateEmailAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}
Delete an email action
deleteEmailAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails/{actionId}/built
Get the built email action
getBuiltEmailAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}
Get a fire-as-person action
getFireAsPersonAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}
Update a fire-as-person action
updateFireAsPersonAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}
Delete a fire-as-person action
deleteFireAsPersonAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built
Get the built fire-as-person action
getBuiltFireAsPersonAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}
Get an incentivize-status-update action
getIncentivizeStatusUpdateAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}
Update an incentivize-status-update action
updateIncentivizeStatusUpdateAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}
Delete an incentivize-status-update action
deleteIncentivizeStatusUpdateAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId}/built
Get the built incentivize-status-update action
getBuiltIncentivizeStatusUpdateAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}
Get an incentivize action
getIncentivizeAction 4 params → 200400401402403415429
PUT
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}
Update an incentivize action
updateIncentivizeAction 4 params body → 200400401402403415429
DELETE
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}
Delete an incentivize action
deleteIncentivizeAction 4 params → 200400401402403415429
GET
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes/{actionId}/built
Get the built incentivize action
getBuiltIncentivizeAction 4 params → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/approves
Create an approve action
createApproveAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/cancel-rewards
Create a cancel-reward action
createCancelRewardAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/create-memberships
Create a create-membership action
createCreateMembershipAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/creatives
Create a creative action
createCreativeAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/declines
Create a decline action
createDeclineAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/displays
Create a display action
createDisplayAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/earn-rewards
Create an earn-reward action
createEarnRewardAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/emails
Create an email action
createEmailAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/expressions
Create an expression action
createExpressionAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person
Create a fire-as-person action
createFireAsPersonAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fulfill-rewards
Create a fulfill-reward action
createFulfillRewardAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivize-status-updates
Create an incentivize-status-update action
createIncentivizeStatusUpdateAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/incentivizes
Create an incentivize action
createIncentivizeAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/redeem-rewards
Create a redeem-reward action
createRedeemRewardAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/remove-memberships
Create a remove-membership action
createRemoveMembershipAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/revoke-rewards
Create a revoke-reward action
createRevokeRewardAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/schedules
Create a schedule action
createScheduleAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/share-events
Create a share-event action
createShareEventAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals
Create a signal action
createSignalAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/signals-v1
Create a signal-v1 action
createSignalV1Action 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/step-signals
Create a step-signal action
createStepSignalAction 3 params body → 200400401402403415429
POST
/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/webhooks
Create a webhook action
createWebhookAction 3 params body → 200400401402403415429

Schemas 331

The contract defines 331 schemas that model the data the API accepts and returns. The most detailed are CampaignControllerActionEarnRewardUpdateRequest (16 properties), CampaignControllerActionApproveUpdateRequest (13 properties), FireAsPersonJourney (13 properties), CampaignControllerActionApproveCreateRequest (13 properties). Each schema is shown below with its type and property counts.

SlotsInCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNameInCampaignControllerActionFireAsPersonResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionResponse
Stored campaign controller action definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.
6 required
BodyInBuiltCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionEmailResponse
object
EnabledInCampaignControllerActionCancelRewardCreateRequest
Choose between static or dynamic enabled
DataMapInCampaignControllerActionFireAsPersonUpdateRequest
object
DataMapInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
object
DataInCampaignControllerActionExpressionResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionEmailUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionExpressionUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/expressions/{actionId} request.
6 properties
DataInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic data
RewardTagsInCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionCreateMembershipCreateRequest
Choose between static or dynamic enabled
ExpressionInCampaignControllerActionExpressionCreateRequest
Choose between static or dynamic expression
CampaignControllerActionCreativeCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/creatives request.
7 properties
EnabledInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionExpressionResponse
object
EventTimeInCampaignControllerActionRedeemRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
BodyInCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseInCampaignControllerActionDisplayResponse
The response as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionIncentivizeStatusUpdateCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivize-status-updates request.
11 properties
DelaysInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic delays
HeadersInBuiltCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionWebhookResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
IncentivizeActionTypeInCampaignControllerActionIncentivizeCreateRequest
Choose between static or dynamic incentivize action type
CampaignControllerActionDataIntelligenceRequest
object
7 properties
PartnerUserIdFireAsPersonIdentification
object
SlotsInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic slots
CampaignControllerActionScheduleCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/schedules request.
10 properties
EnabledInCampaignControllerActionSignalCreateRequest
Choose between static or dynamic enabled
FileAttributes
object
2 properties
CampaignControllerActionFireAsPersonUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fire-as-person/{actionId} request.
12 properties
ExtraDataInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic extra data
MessageInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic message
CampaignControllerActionCreateMembershipResponse
object
BuiltCampaignControllerActionDisplayResponse
object
DataInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic data
DataMapInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
object
SlotsInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic slots
ReviewStatusInCampaignControllerActionIncentivizeUpdateRequest
Choose between static or dynamic review status
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
EnabledInCampaignControllerActionRemoveMembershipCreateRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionRevokeRewardCreateRequest
Choose between static or dynamic enabled
EventTimeInCampaignControllerActionRedeemRewardCreateRequest
Choose between static or dynamic event time
EnabledInCampaignControllerActionDataIntelligenceRequest
Choose between static or dynamic enabled
CampaignControllerActionFireAsPersonCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fire-as-person request.
12 properties
CampaignControllerActionSignalResponse
object
CampaignControllerActionEarnRewardUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/earn-rewards/{actionId} request.
16 properties
NameInCampaignControllerActionSignalUpdateRequest
Choose between static or dynamic name
CampaignControllerActionDeclineCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/declines request.
11 properties
CampaignControllerActionFulfillRewardUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fulfill-rewards/{actionId} request.
10 properties
EnabledInCampaignControllerActionDisplayCreateRequest
Choose between static or dynamic enabled
MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionIncentivizeUpdateRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionDeclineCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionStepSignalResponse
object
DataMapInBuiltCampaignControllerActionFireAsPersonResponse
object
PartnerEventIdFireAsPersonIdentification
object
AudienceIdInCampaignControllerActionCreateMembershipUpdateRequest
Choose between static or dynamic audience id
DataMapInCampaignControllerActionWebhookUpdateRequest
object
HeadersInCampaignControllerActionDisplayCreateRequest
Choose between static or dynamic headers
EnabledInCampaignControllerActionSignalV1UpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionIncentivizeStatusUpdateUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivize-status-updates/{actionId} request.
11 properties
DataMapInCampaignControllerActionIncentivizeUpdateRequest
object
DatesInCampaignControllerActionScheduleResponse
The dates as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDisplayCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/displays request.
7 properties
CampaignControllerActionDeclineResponse
object
RewardSupplierIdInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic reward supplier id
BuiltCampaignControllerActionIncentivizeResponse
object
DataMapInCampaignControllerActionEarnRewardUpdateRequest
object
DataInCampaignControllerActionIncentivizeUpdateRequest
Choose between static or dynamic data
DataMapInCampaignControllerActionExpressionUpdateRequest
object
AmountInCampaignControllerActionFulfillRewardCreateRequest
Choose between static or dynamic amount
TagsInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic tags
EnabledInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionApproveCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/approves request.
13 properties
MessageInCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic extra data
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic legacy action id
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic legacy action id
DataMapInCampaignControllerActionScheduleUpdateRequest
object
DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
EnabledInCampaignControllerActionResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
ApiResponse
object
3 properties
EventTimeInCampaignControllerActionFireAsPersonResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerRewardIdInCampaignControllerActionFulfillRewardUpdateRequest
Choose between static or dynamic partner reward id
ExpressionInCampaignControllerActionExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic person id
DataInBuiltCampaignControllerActionIncentivizeResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseInCampaignControllerActionDisplayCreateRequest
Choose between static or dynamic response
CampaignControllerActionStepSignalCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/step-signals request.
6 properties
DataMapInCampaignControllerActionSignalResponse
object
ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic value of event being rewarded
DataInCampaignControllerActionSignalResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic partner event id
AudienceIdInCampaignControllerActionCreateMembershipResponse
The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionIncentivizeResponse
object
AudienceIdInCampaignControllerActionRemoveMembershipResponse
The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInCampaignControllerActionRedeemRewardUpdateRequest
Choose between static or dynamic event time
DataMapInCampaignControllerActionWebhookCreateRequest
object
DataMapInCampaignControllerActionEmailResponse
object
CampaignControllerActionWebhookCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/webhooks request.
6 properties
CampaignControllerActionEarnRewardCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/earn-rewards request.
13 properties
ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionEmailResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentReferenceResponse
object
2 properties
RewardNameInCampaignControllerActionEarnRewardResponse
The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionSignalCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals request.
7 properties
DataInCampaignControllerActionEmailCreateRequest
Choose between static or dynamic data
CampaignControllerActionEmailUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/emails/{actionId} request.
6 properties
CampaignControllerActionSignalUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals/{actionId} request.
7 properties
EnabledInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic enabled
ExtraDataInCampaignControllerActionScheduleResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionEmailCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/emails request.
6 properties
EventTypeInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic event type
EnabledInCampaignControllerActionCreativeCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionFireAsPersonResponse
object
DelaysInCampaignControllerActionScheduleResponse
The delays as configured: a literal value, or an expression (type:string) when defined dynamically.
ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentReferenceRequest
object
2 properties
EnabledInCampaignControllerActionSignalUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionDisplayUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/displays/{actionId} request.
7 properties
TagsInCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionRedeemRewardResponse
object
EnabledInCampaignControllerActionEmailCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionIncentivizeCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivizes request.
9 properties
DataInCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic event time
CampaignControllerActionCancelRewardCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/cancel-rewards request.
6 properties
CampaignControllerActionDeclineUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/declines/{actionId} request.
11 properties
DataInCampaignControllerActionIncentivizeCreateRequest
Choose between static or dynamic data
PartnerRewardIdInCampaignControllerActionFulfillRewardResponse
The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionIncentivizeCreateRequest
object
EnabledInCampaignControllerActionRemoveMembershipUpdateRequest
Choose between static or dynamic enabled
DataInCampaignControllerActionScheduleResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionEmailResponse
object
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionCancelRewardResponse
object
CampaignControllerActionRevokeRewardCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/revoke-rewards request.
6 properties
DataInCampaignControllerActionSignalCreateRequest
Choose between static or dynamic data
DataMapInCampaignControllerActionSignalCreateRequest
object
TagsInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic tags
DelaysInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic delays
PersonIdInBuiltCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionFulfillRewardCreateRequest
Choose between static or dynamic enabled
DataInCampaignControllerActionWebhookUpdateRequest
Choose between static or dynamic data
PersonIdInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic person id
ReviewStatusInCampaignControllerActionIncentivizeResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionApproveCreateRequest
Choose between static or dynamic enabled
ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceRequest
Choose between static or dynamic profile risk update interval
DataInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic data
EventTimeInCampaignControllerActionFulfillRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionScheduleResponse
object
EnabledInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic enabled
ScheduleNameInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic schedule name
MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse
The move to pending as configured: a literal value, or an expression (type:string) when defined dynamically.
AudienceIdInCampaignControllerActionCreateMembershipCreateRequest
Choose between static or dynamic audience id
HeadersInCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionFulfillRewardResponse
object
CampaignControllerActionScheduleUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/schedules/{actionId} request.
10 properties
DataInCampaignControllerActionEmailUpdateRequest
Choose between static or dynamic data
FileInputStreamRequest
object
2 properties 2 required
MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic move to pending
DataInCampaignControllerActionWebhookCreateRequest
Choose between static or dynamic data
LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardActionIdInCampaignControllerActionEarnRewardResponse
The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.
BodyInCampaignControllerActionDisplayUpdateRequest
Choose between static or dynamic body
ExtraDataInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic extra data
CampaignControllerActionRemoveMembershipUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/remove-memberships/{actionId} request.
5 properties
DataMapInCampaignControllerActionEarnRewardResponse
object
PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic partner event id
NameInCampaignControllerActionSignalCreateRequest
Choose between static or dynamic name
CampaignControllerActionIncentivizeUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/incentivizes/{actionId} request.
9 properties
CampaignControllerActionStepSignalUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/step-signals/{actionId} request.
6 properties
IntelligenceProviderInCampaignControllerActionDataIntelligenceRequest
Choose between static or dynamic intelligence provider
RewardTagsInCampaignControllerActionApproveUpdateRequest
Choose between static or dynamic reward tags
EnabledInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionCreateMembershipUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/create-memberships/{actionId} request.
5 properties
EnabledInCampaignControllerActionSignalV1CreateRequest
Choose between static or dynamic enabled
CampaignControllerActionExpressionCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/expressions request.
6 properties
EventNameInCampaignControllerActionDataIntelligenceRequest
Choose between static or dynamic event name
EnabledInCampaignControllerActionExpressionUpdateRequest
Choose between static or dynamic enabled
DataInCampaignControllerActionFireAsPersonResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionEmailUpdateRequest
object
CampaignControllerActionShareEventRequest
object
4 properties
EnabledInCampaignControllerActionExpressionCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionCancelRewardUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/cancel-rewards/{actionId} request.
6 properties
WebhookIdInCampaignControllerActionWebhookCreateRequest
Choose between static or dynamic webhook id
NameInCampaignControllerActionSignalResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNameInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic event name
FireAsPersonJourney
object
13 properties
EnabledInCampaignControllerActionWebhookUpdateRequest
Choose between static or dynamic enabled
RewardSupplierIdInCampaignControllerActionEarnRewardResponse
The reward supplier id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionIncentivizeResponse
object
IncentivizeActionTypeInCampaignControllerActionIncentivizeUpdateRequest
Choose between static or dynamic incentivize action type
RewardActionIdInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic reward action id
EnabledInCampaignControllerActionRevokeRewardUpdateRequest
Choose between static or dynamic enabled
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
DataInCampaignControllerActionExpressionCreateRequest
Choose between static or dynamic data
EventTimeInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic event time
DatesInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic dates
Duration
string
[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545section-3.3.6) duration string.
ResponseInCampaignControllerActionDisplayUpdateRequest
Choose between static or dynamic response
DataInCampaignControllerActionIncentivizeResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionEmailResponse
object
DatesInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic dates
DataInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic data
DataMapInCampaignControllerActionEmailCreateRequest
object
EventTimeInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic event time
ScheduleNameInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic schedule name
DataInCampaignControllerActionSignalUpdateRequest
Choose between static or dynamic data
HeadersInCampaignControllerActionDisplayUpdateRequest
Choose between static or dynamic headers
DataMapInCampaignControllerActionIncentivizeResponse
object
CampaignControllerActionApproveUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/approves/{actionId} request.
13 properties
DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse
object
ZoneNameInCampaignControllerActionEmailResponse
The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionStepSignalCreateRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic enabled
EmailFireAsPersonIdentification
object
ScheduleNameInCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionRemoveMembershipCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/remove-memberships request.
5 properties
CampaignControllerActionResponseBase
object
6 properties
ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic review status
EnabledInCampaignControllerActionApproveUpdateRequest
Choose between static or dynamic enabled
SignalPollingIdInCampaignControllerActionSignalCreateRequest
Choose between static or dynamic signal polling id
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
DataInCampaignControllerActionExpressionUpdateRequest
Choose between static or dynamic data
CampaignControllerActionSignalV1UpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals-v1/{actionId} request.
6 properties
FireAsPersonIdentification
CampaignControllerActionWebhookUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/webhooks/{actionId} request.
6 properties
EventTimeInCampaignControllerActionEarnRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionShareEventResponse
object
ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse
The profile risk update interval as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInCampaignControllerActionEarnRewardResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNameInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic event name
CampaignControllerActionIncentivizeStatusUpdateResponse
object
DataInCampaignControllerActionScheduleCreateRequest
Choose between static or dynamic data
EventTimeInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic event time
MessageInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic message
EnabledInCampaignControllerActionCancelRewardUpdateRequest
Choose between static or dynamic enabled
PersonIdInCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic value of event being rewarded
PersonIdFireAsPersonIdentification
object
IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse
The intelligence provider as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionFireAsPersonCreateRequest
Choose between static or dynamic data
CampaignControllerActionRevokeRewardUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/revoke-rewards/{actionId} request.
6 properties
AudienceIdInCampaignControllerActionRemoveMembershipCreateRequest
Choose between static or dynamic audience id
DataMapInCampaignControllerActionFireAsPersonCreateRequest
object
AmountInCampaignControllerActionFulfillRewardUpdateRequest
Choose between static or dynamic amount
BuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
RewardNameInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic reward name
FireAsPersonIdentificationBase
object
2 properties
EventTimeInBuiltCampaignControllerActionFireAsPersonResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionDisplayUpdateRequest
Choose between static or dynamic enabled
EventTypeInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic event type
DataMapInCampaignControllerActionScheduleResponse
object
EventNameInCampaignControllerActionDataIntelligenceResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic data
DataMapInCampaignControllerActionScheduleCreateRequest
object
CampaignControllerActionRevokeRewardResponse
object
RewardTagsInCampaignControllerActionApproveCreateRequest
Choose between static or dynamic reward tags
CampaignControllerActionApproveResponse
object
EnabledInCampaignControllerActionStepSignalUpdateRequest
Choose between static or dynamic enabled
ExtraDataInCampaignControllerActionFireAsPersonResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionRedeemRewardUpdateRequest
Choose between static or dynamic enabled
CampaignControllerActionCreativeUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/creatives/{actionId} request.
7 properties
CampaignControllerActionWebhookResponse
object
EnabledInCampaignControllerActionShareEventRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic enabled
DataMapInCampaignControllerActionFireAsPersonResponse
object
WebhookIdInCampaignControllerActionWebhookResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerRewardIdInCampaignControllerActionFulfillRewardCreateRequest
Choose between static or dynamic partner reward id
EventTimeInCampaignControllerActionFulfillRewardUpdateRequest
Choose between static or dynamic event time
ResponseInBuiltCampaignControllerActionDisplayResponse
The response as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionCreateMembershipCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/create-memberships request.
5 properties
EnabledInCampaignControllerActionCreateMembershipUpdateRequest
Choose between static or dynamic enabled
DataInBuiltCampaignControllerActionFireAsPersonResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionEarnRewardResponse
object
DataInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic data
CampaignControllerActionSignalV1Response
object
CampaignControllerActionRedeemRewardCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/redeem-rewards request.
8 properties
EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionWebhookCreateRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionRedeemRewardCreateRequest
Choose between static or dynamic enabled
DataMapInCampaignControllerActionEarnRewardCreateRequest
object
DataMapInCampaignControllerActionExpressionResponse
object
RewardNameInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic reward name
SignalPollingIdInCampaignControllerActionSignalResponse
The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDisplayResponse
object
DataInCampaignControllerActionEarnRewardResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionDeclineUpdateRequest
Choose between static or dynamic enabled
WebhookIdInCampaignControllerActionWebhookUpdateRequest
Choose between static or dynamic webhook id
DataMapInCampaignControllerActionWebhookResponse
object
ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInCampaignControllerActionExpressionUpdateRequest
Choose between static or dynamic expression
BuiltCampaignControllerActionResponseBase
object
6 properties
ReviewStatusInCampaignControllerActionIncentivizeCreateRequest
Choose between static or dynamic review status
CampaignControllerActionDataIntelligenceResponse
object
EnabledInCampaignControllerActionFulfillRewardUpdateRequest
Choose between static or dynamic enabled
EnabledInCampaignControllerActionIncentivizeCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionRedeemRewardUpdateRequest
object
Body of a PUT /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/redeem-rewards/{actionId} request.
8 properties
IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse
The incentivize action type as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionSignalV1CreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/signals-v1 request.
6 properties
CampaignControllerActionCreativeResponse
object
CampaignControllerActionFulfillRewardCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers/{controllerId}/actions/fulfill-rewards request.
10 properties
SignalPollingIdInCampaignControllerActionSignalUpdateRequest
Choose between static or dynamic signal polling id
ExtraDataInCampaignControllerActionEarnRewardCreateRequest
Choose between static or dynamic extra data
ExtraDataInCampaignControllerActionScheduleUpdateRequest
Choose between static or dynamic extra data
BodyInCampaignControllerActionDisplayCreateRequest
Choose between static or dynamic body
AudienceIdInCampaignControllerActionRemoveMembershipUpdateRequest
Choose between static or dynamic audience id
EventTimeInCampaignControllerActionFulfillRewardCreateRequest
Choose between static or dynamic event time
CampaignControllerActionRemoveMembershipResponse
object
MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateUpdateRequest
Choose between static or dynamic move to pending
RewardActionIdInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic reward action id
ExtraDataInCampaignControllerActionFireAsPersonUpdateRequest
Choose between static or dynamic extra data
DataMapInCampaignControllerActionExpressionCreateRequest
object
ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateCreateRequest
Choose between static or dynamic review status
ZoneNameInCampaignControllerActionEmailCreateRequest
Choose between static or dynamic zone name
BuiltCampaignControllerActionFireAsPersonResponse
object
DataMapInCampaignControllerActionSignalUpdateRequest
object
RewardSupplierIdInCampaignControllerActionEarnRewardUpdateRequest
Choose between static or dynamic reward supplier id
EnabledInCampaignControllerActionCreativeUpdateRequest
Choose between static or dynamic enabled
ZoneNameInCampaignControllerActionEmailUpdateRequest
Choose between static or dynamic zone name
DataInBuiltCampaignControllerActionEmailResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-campaign-controllers-actions-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
AE Profile APIs.io
Extole Authentication API
AE Profile APIs.io
Extole Batch Jobs API
AE Profile APIs.io
Extole Blocks API
AE Profile APIs.io
Extole Campaign Controllers API
AE Profile APIs.io
Extole Campaign Controllers Triggers API
AE Profile APIs.io
Extole Campaign Flow Steps API
AE Profile APIs.io
Extole Campaigns API
AE Profile APIs.io
Extole Components API
AE Profile APIs.io
Extole Components Grants API
AE Profile APIs.io
Extole Components Settings API
AE Profile APIs.io
Extole Components Subscriptions API
AE Profile APIs.io
#Campaign Controllers Actions
← Back to E APIs
API Details
ID
extole:extole-campaign-controllers-actions-api
Base URL
https://api.extole.io
Docs
https://docs.extole.com/
Provider
Extole
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=extole-campaign-controllers-actions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/extole-campaign-controllers-actions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Extole Campaign Controllers Actions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.