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