Extole Campaigns API
The Campaigns API from Extole — 31 operation(s) for campaigns.
Extole Campaigns API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 34 operations across 31 paths, and defines 517 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.
34 operations
31 paths
517 schemas
1 DELETE11 GET20 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Campaigns 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 34
Across 31 paths, the API surfaces 34 operations — 1 DELETE, 11 GET, 20 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Campaigns 34
GET
/v2/campaign-summaries
List campaign summaries
GET
/v2/campaign-summaries/{campaignId}{version}
Get a campaign summary
GET
/v2/campaigns
List campaigns
POST
/v2/campaigns
Upload a new campaign from archive
GET
/v2/campaigns/built
List built campaigns
GET
/v2/campaigns/deleted
List deleted campaigns
GET
/v2/campaigns/duplicatable
List duplicatable campaigns
GET
/v2/campaigns/{campaignId}/versions
List campaign versions
GET
/v2/campaigns/{campaignId}/versions/{campaignVersion}
Get a campaign version
GET
/v2/campaigns/{campaignId}{version}
Get a campaign
PUT
/v2/campaigns/{campaignId}{version}
Update a campaign from archive
DELETE
/v2/campaigns/{campaignId}{version}
Delete a campaign
GET
/v2/campaigns/{campaignId}{version}/built
Get a built campaign
GET
/v2/campaigns/{campaignId}{version}.zip
Download a campaign bundle
POST
/v2/campaigns/program/{programLabel}/rename
Rename a campaigns program label
POST
/v2/campaigns/{campaignId}{version}/archive
Archive a campaign
POST
/v2/campaigns/{campaignId}{version}/discard
Discard a campaign draft
POST
/v2/campaigns/{campaignId}{version}/duplicate
Duplicate a campaign
POST
/v2/campaigns/{campaignId}{version}/end
End a campaign
POST
/v2/campaigns/{campaignId}{version}/launch-burst
Launch a campaign in burst mode
POST
/v2/campaigns/{campaignId}{version}/launch-test
Launch a campaign in test mode
POST
/v2/campaigns/{campaignId}{version}/live
Set a campaign live
POST
/v2/campaigns/{campaignId}{version}/lock
Lock a campaign
POST
/v2/campaigns/{campaignId}{version}/make-latest-draft
Make a campaign version the latest draft
POST
/v2/campaigns/{campaignId}{version}/make-latest-preserve-state
Make a campaign version latest while preserving state
POST
/v2/campaigns/{campaignId}{version}/make-latest-published
Make a campaign version the latest published
POST
/v2/campaigns/{campaignId}{version}/pause
Pause a campaign
POST
/v2/campaigns/{campaignId}{version}/publish
Publish a campaign
POST
/v2/campaigns/{campaignId}{version}/schedule
Schedule a campaign state change
POST
/v2/campaigns/{campaignId}{version}/stop
Stop a campaign
POST
/v2/campaigns/{campaignId}{version}/unarchive
Unarchive a campaign
POST
/v2/campaigns/{campaignId}{version}/undelete
Undelete a campaign
POST
/v2/campaigns/{campaignId}{version}/unlock
Unlock a campaign
PUT
/v2/campaigns/program/{program_label}/update
Update campaigns by program label
Schemas 517
The contract defines 517 schemas that model the data the API accepts and returns. The most detailed are CampaignResponse (27 properties), BuiltCampaignResponse (27 properties), RewardRuleResponse (22 properties), CampaignSummaryResponse (20 properties). Each schema is shown below with its type and property counts.
BuiltCampaignComponentVariableResponseAsCss
object
ValueInBuiltJourneyKeyResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignUnlockRequest
object
1 property
1 required
BuiltCampaignFlowStepResponse
object
14 properties
14 required
DataInCampaignControllerActionScheduleResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionSignalResponse
object
9 required
FilterScopeInCampaignControllerTriggerHasPriorRewardResponse
The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.
VariantSelectorInBuiltCampaignResponse
The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInBuiltCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInExpressionSettingFilterResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignResponse
object
Stored campaign definition. Fields variantselector and variants are unevaluated and appear in buildtime-evaluatable form.
27 properties
27 required
BuiltComponentClientKeyFlowVariableResponse
object
13 required
CampaignComponentFacetResponse
object
2 properties
ResponseInCampaignControllerActionDisplayResponse
The response as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignFlowStepAppTypeResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInBuiltCampaignControllerActionEarnRewardResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyNameInCampaignJourneyEntryResponse
The journey name 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.
BuiltCampaignControllerActionCreateMembershipResponse
object
7 required
CampaignComponentResponse
object
Stored campaign component definition. Field displayname is unevaluated and appears in buildtime-evaluatable form.
19 properties
19 required
BuiltCampaignStepResponse
10 required
DelaysInBuiltCampaignControllerActionScheduleResponse
The delays as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerAccessResponse
object
11 required
ScheduleNameInCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableResponse
The captured setting values description as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignPublishRequest
object
2 properties
2 required
MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionIncentivizeResponse
object
ScopeInCampaignFrontendControllerResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionEmailResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentPartnerEnumVariableResponse
object
Stored campaign component partner enum variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
SingularNounNameInCampaignFlowStepWordsResponse
The singular noun name as configured: a literal value, or an expression (type:string) when defined dynamically.
ScheduleNameInBuiltCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsClientDomainIdList
object
NameInCampaignControllerResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsStringList
object
SumOfValueMaxInCampaignControllerTriggerHasPriorStepResponse
The sum of value max 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.
DataInBuiltCampaignControllerActionFireAsPersonResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltComponentEnumListVariableResponse
object
11 required
EventNamesInCampaignControllerTriggerRewardEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionCreativeResponse
object
12 required
ExtraDataInCampaignControllerActionScheduleResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignFlowStepAppResponse
The name 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.
PersonIdInBuiltCampaignControllerTriggerAudienceMembershipResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInBuiltCampaignControllerActionExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltComponentRewardSupplierIdListVariableResponse
object
11 required
BuiltCampaignControllerActionDeclineResponse
object
13 required
CampaignComponentSettingResponseBase
object
6 properties
CampaignComponentVariableResponseAsColor
object
BuiltCampaignControllerTriggerMaxMindResponse
object
14 required
FilterMinDateInCampaignControllerTriggerHasPriorStepResponse
The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsAdminIcon
object
CampaignControllerTriggerEventResponse
object
BuiltCampaignFlowStepAppResponse
object
5 properties
5 required
ScopeInCampaignControllerResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerActionResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignLabelResponse
object
2 properties
BuiltCampaignControllerTriggerStepEventResponse
object
FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponse
object
8 properties
SumOfFaceValueMaxInCampaignControllerTriggerHasPriorRewardResponse
The sum of face value max as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
CampaignControllerActionDeclineResponse
object
BuiltCampaignControllerTriggerClientDomainResponse
object
11 required
SlotsInBuiltCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
DefaultInComponentSettingVariableValues
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
PersonIdInCampaignControllerTriggerHasPriorStepResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionDataIntelligenceResponse
object
9 required
RewardTagsInBuiltCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
SettingFilterResponse
DescriptionInCampaignFlowStepMetricResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
CountMaxInCampaignControllerTriggerHasPriorStepResponse
The count max as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentEnumVariableResponse
object
Stored campaign component enum variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
TargetingAttributesInCampaignControllerTriggerEventTargetingResponse
The targeting attributes as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerTargetingResponse
object
PersonIdInCampaignControllerTriggerJourneyCheckResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMaxValueInCampaignControllerTriggerHasPriorStepResponse
The filter max value as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentComponentSettingLookupVariableResponse
object
Stored campaign component component setting lookup variable definition. Fields description and capturedsettingvaluesdescription are unevaluated and appear in b…
12 required
CampaignControllerActionCreativeResponse
object
BuiltCampaignComponentVariableResponseAsUrl
object
DataInCampaignControllerActionWebhookResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsGlobComponentPath
object
DataInBuiltCampaignControllerActionSignalResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerHasPriorRewardResponse
object
DataMapInCampaignControllerActionEarnRewardResponse
object
DataMapInBuiltCampaignControllerActionExpressionResponse
object
FilterRewardSupplierIdsInCampaignControllerTriggerHasPriorRewardResponse
The filter reward supplier ids 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.
StepBuilderInCampaignStepResponseBase
The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentReferenceResponse
object
2 properties
NameInStepDataResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerGroupResponse
object
PersonIdInBuiltCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
CountMinInCampaignControllerTriggerHasPriorStepResponse
The count min as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionFulfillRewardResponse
object
10 required
ActionTypeInCampaignControllerTriggerLegacyQualityResponse
The action type as configured: a literal value, or an expression (type:string) when defined dynamically.
DefaultQualityScoreInCampaignControllerTriggerMaxMindResponse
The default quality score as configured: a literal value, or an expression (type:string) when defined dynamically.
InstallInCampaignComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
ZoneNameInCampaignControllerActionEmailResponse
The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentStringMapVariableResponse
object
Stored campaign component string map variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
BuiltCampaignControllerTriggerReferredByEventResponse
object
11 required
CampaignProgramUpdateRequest
object
Body of a PUT /v2/campaigns/program/{programlabel}/update request.
1 property
1 required
FireAsPersonIdentificationBase
object
2 properties
CampaignComponentVariableResponseAsFont
object
SendPolicyInCampaignControllerResponse
The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerRewardIdInBuiltCampaignControllerActionFulfillRewardResponse
The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentComponentIdVariableResponse
object
Stored campaign component component id variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
CountMinInCampaignControllerTriggerHasPriorRewardResponse
The count min as configured: a literal value, or an expression (type:string) when defined dynamically.
StepBuilderInBuiltCampaignStepResponseBase
The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.
ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
SlotsInCampaignControllerTriggerRewardEventResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledOnStatesInCampaignFrontendControllerResponse
The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerMaxMindResponse
object
ComponentIdFilterResponse
object
1 property
BuiltCampaignComponentVariableResponseAsColor
object
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.
CampaignControllerTriggerLegacyQualityResponse
object
FireAsPersonJourney
object
13 properties
CampaignFlowStepResponse
object
Stored campaign flow step definition. Fields flowpath, sequence, stepname, icontype, tags, name, iconcolor, and description are unevaluated and appear in build…
14 properties
14 required
CampaignControllerActionRemoveMembershipResponse
object
FilterMaxDateInCampaignControllerTriggerHasPriorStepResponse
The filter max date as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsDelayList
object
PersonCountingNameInCampaignFlowStepWordsResponse
The person counting name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionWebhookResponse
object
8 required
ScopeInStepDataResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterProgramLabelsInCampaignControllerTriggerHasPriorStepResponse
The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionRevokeRewardResponse
object
8 required
CampaignControllerActionCancelRewardResponse
object
CampaignControllerTriggerStickyJourneyResponse
object
SlotsInCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerAudienceMembershipResponse
object
12 required
FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionIncentivizeResponse
object
CampaignControllerActionResponse
Stored campaign controller action definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.
6 required
PartnerEventIdFireAsPersonIdentification
object
TriggerDescriptionInCampaignControllerTriggerResponseBase
The trigger description as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMaxAgeInCampaignControllerTriggerHasPriorRewardResponse
The filter max age as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignFlowStepAppResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
HavingAnyDataNameInCampaignControllerTriggerStepEventResponse
The having any data name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsIntegerList
object
CampaignVersionDescriptionResponse
object
13 properties
13 required
FormDataContentDisposition
object
8 properties
DataMapInCampaignControllerActionFireAsPersonResponse
object
CountMatchesInCampaignControllerTriggerHasPriorStepResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsAudienceId
object
DataInCampaignControllerActionEarnRewardResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInCampaignControllerActionFireAsPersonResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionSignalV1Response
object
8 required
DescriptionInCampaignFlowStepResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepWordsResponse
object
5 properties
CampaignControllerTriggerExpressionResponse
object
ComponentSettingVariableValues
object
Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for t…
2 properties
BuiltCampaignComponentVariableResponseAsString
object
JourneyNamesInCampaignControllerResponse
The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.
AudienceIdInCampaignControllerActionCreateMembershipResponse
The audience id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsWebhookId
object
EnInComponentSettingVariableValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
FilterScopeInCampaignControllerTriggerHasPriorStepResponse
The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignScheduleRequest
object
4 properties
DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse
object
BuiltCampaignControllerActionRedeemRewardResponse
object
9 required
RewardNamesInCampaignControllerTriggerSendRewardEventResponse
The reward names as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignLockRequest
object
1 property
1 required
BuiltCampaignControllerTriggerResponse
10 required
CampaignControllerActionRedeemRewardResponse
object
PartnerUserIdFireAsPersonIdentification
object
CampaignFlowStepMetricResponse
object
Stored campaign flow step metric definition. Fields name, description, expression, unit, and tags are unevaluated and appear in buildtime-evaluatable form.
8 properties
8 required
TriggerNameInCampaignControllerTriggerResponseBase
The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionSignalV1Response
object
VerbNameInCampaignFlowStepWordsResponse
The verb name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsAudienceIdList
object
CampaignControllerTriggerZoneStateResponse
object
BuiltCampaignControllerActionShareEventResponse
object
6 required
PersistTypesInStepDataResponse
The persist types as configured: a literal value, or an expression (type:string) when defined dynamically.
FlowPathInCampaignFlowStepResponse
The flow path 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.
DataMapInCampaignControllerActionScheduleResponse
object
PartnerEventId
object
2 properties
ResponseInBuiltCampaignControllerActionDisplayResponse
The response as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignDuplicateRequest
object
4 properties
4 required
CampaignComponentVariableResponseAsExtoleClientKey
object
FilterExpressionInCampaignControllerTriggerHasPriorRewardResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsBoolean
object
CampaignLaunchTestRequest
object
3 properties
EventNamesInCampaignControllerTriggerStepEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsBrowserSideJavascript
object
WebhookIdInCampaignComponentPartnerEnumListVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignScheduleStateRequest
object
1 property
FilterFaceValueTypesInCampaignControllerTriggerHasPriorRewardResponse
The filter face value types as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionWebhookResponse
object
EventNamesInCampaignControllerTriggerEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
SumOfValueMinInCampaignControllerTriggerHasPriorStepResponse
The sum of value min as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionFulfillRewardResponse
object
FilterExpressionInCampaignControllerTriggerHasPriorStepResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerReferredByEventResponse
object
BuiltCampaignFlowStepWordsResponse
object
5 properties
EnabledInCampaignStepResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMaxAgeInCampaignControllerTriggerHasPriorStepResponse
The filter max age as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentClientKeyFlowVariableResponse
object
Stored campaign component client key flow variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
11 required
ExtraDataInBuiltCampaignControllerActionScheduleResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInBuiltCampaignControllerActionFireAsPersonResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
TaxYearStartInCampaignControllerTriggerHasPriorRewardResponse
The tax year start as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsDelay
object
LabelInCampaignControllerTriggerStickyJourneyResponse
The label as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionCancelRewardResponse
object
8 required
CampaignStepResponseBase
object
10 properties
CampaignControllerTriggerHasPriorStepResponse
object
BuiltCampaignControllerTriggerHasIdentityResponse
object
10 required
BuiltComponentSocketResponseAsSocket
object
9 required
DataInCampaignControllerActionIncentivizeResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsCss
object
CampaignControllerActionWebhookResponse
object
BuiltCampaignControllerActionEarnRewardResponse
object
14 required
DatesInBuiltCampaignControllerActionScheduleResponse
The dates as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltComponentSocketResponseAsMultiSocket
object
9 required
PluralNounNameInCampaignFlowStepWordsResponse
The plural noun name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionResponseBase
object
6 properties
BuiltComponentEnumVariableResponse
object
11 required
CampaignComponentEnumListVariableResponse
object
Stored campaign component enum list variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
FilterNamesInCampaignControllerTriggerHasPriorRewardResponse
The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.
KeyTypeInStepDataResponse
The key type as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTypeInCampaignControllerTriggerEventResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
HavingAnyAudienceIdInCampaignControllerTriggerAudienceMembershipResponse
The having any audience id as configured: a literal value, or an expression (type:string) when defined dynamically.
ParentTriggerGroupNameInCampaignControllerTriggerResponseBase
The parent trigger group name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsInteger
object
DataMapInBuiltCampaignControllerActionEarnRewardResponse
object
ComponentAssetResponse
object
5 properties
BuiltCampaignControllerActionIncentivizeResponse
object
DefaultValueInBuiltStepDataResponse
The default value as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInCampaignFlowStepMetricResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMinAgeInCampaignControllerTriggerHasPriorRewardResponse
The filter min age as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerHasPriorStepResponse
object
35 required
FilterMaxDateInCampaignControllerTriggerHasPriorRewardResponse
The filter max date as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltComponentComponentSettingLookupVariableResponse
object
14 required
CampaignControllerTriggerJourneyCheckResponse
object
StepNameInCampaignControllerTriggerZoneStateResponse
The step name as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueInStepDataResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsClientKey
object
CampaignComponentVariableResponseAsImage
object
EventNameInCampaignControllerTriggerDataIntelligenceEventResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionExpressionResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionSignalResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerJourneyCheckResponse
object
ValueInJourneyKeyResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
PriorityInCampaignJourneyEntryResponse
The priority as configured: a literal value, or an expression (type:string) when defined dynamically.
SettingFilterResponseBase
object
1 property
TriggerPhaseInCampaignControllerTriggerResponseBase
The trigger phase as configured: a literal value, or an expression (type:string) when defined dynamically.
LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerRewardIdInCampaignControllerActionFulfillRewardResponse
The partner reward id as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionScheduleResponse
object
CampaignControllerActionStepSignalResponse
object
AliasesInCampaignFrontendControllerResponse
The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionWebhookResponse
object
CampaignControllerActionIncentivizeStatusUpdateResponse
object
EventNameInCampaignControllerActionFireAsPersonResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyKeyResponse
object
2 properties
BuiltCampaignControllerTriggerAudienceMembershipEventResponse
object
12 required
DataInCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionWebhookResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInCampaignControllerActionFireAsPersonResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
VariantsInCampaignResponse
The variants as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
ZoneNameInCampaignControllerTriggerZoneStateResponse
The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.
DimensionInStepDataResponse
The dimension as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerSendRewardEventResponse
object
DataMapInCampaignControllerActionEmailResponse
object
CampaignControllerActionShareEventResponse
object
ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentRewardSupplierIdListVariableResponse
object
Stored campaign component reward supplier id list variable definition. Fields description and allowedrewardsupplierids are unevaluated and appear in buildtime-…
9 required
BuiltComponentAssetResponse
object
5 properties
5 required
CampaignComponentSocketResponseAsSocket
object
Stored campaign component socket definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
DescriptionInCampaignComponentSettingResponseBase
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionStepSignalResponse
object
8 required
CampaignControllerTriggerGroupResponse
object
CampaignFrontendControllerResponse
object
Stored campaign frontend controller definition. Fields enabled, name, scope, enabledonstates, category, aliases, journeynames, sendpolicy, and stepbuilder are…
18 required
CampaignStepResponse
10 required
CampaignControllerTriggerAccessResponse
object
DefaultInComponentSettingVariableValuesOpenApiDocumentation
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
CampaignFlowStepAppResponse
object
Stored campaign flow step app definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
6 properties
6 required
FilterCampaignIdsInCampaignControllerTriggerHasPriorStepResponse
The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.
HavingAllNamesInCampaignControllerTriggerHasPriorStepResponse
The having all names as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerShareResponse
object
FilterQualityInCampaignControllerTriggerHasPriorStepResponse
The filter quality as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerScoreResponse
object
13 required
BuiltCampaignControllerTriggerShareResponse
object
12 required
BuiltCampaignResponse
object
campaign after buildtime evaluation. Fields variantselector and variants are already evaluated.
27 properties
27 required
BuiltCampaignControllerTriggerEventResponse
object
RiskThresholdInCampaignControllerTriggerMaxMindResponse
The risk threshold as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltJourneyKeyResponse
object
2 properties
SignalPollingIdInBuiltCampaignControllerActionSignalResponse
The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerDataIntelligenceEventResponse
object
11 required
ComponentFacetSettingFilterResponse
object
3 required
SelectorsInCampaignControllerResponse
The selectors as configured: a literal value, or an expression (type:string) when defined dynamically.
QualityRuleResponse
object
5 properties
5 required
RewardRuleResponse
object
22 properties
22 required
BodyInBuiltCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
EmailFireAsPersonIdentification
object
DataInCampaignControllerActionExpressionResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionIncentivizeResponse
object
BuiltCampaignComponentSettingResponseBase
object
6 properties
BuiltCampaignJourneyEntryResponse
object
13 required
EventTimeInCampaignControllerActionRedeemRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignJourneyEntryResponse
object
Stored campaign journey entry definition. Fields enabled, journeyname, priority, and stepbuilder are unevaluated and appear in buildtime-evaluatable form.
13 required
CampaignComponentSocketResponseAsMultiSocket
object
Stored campaign component socket definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
CountMatchesInCampaignControllerTriggerHasPriorRewardResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionScheduleResponse
object
RewardRuleExpression
object
2 properties
ClientDomainIdsInCampaignControllerTriggerClientDomainResponse
The client domain ids as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignFlowStepAppTypeResponse
object
1 property
RewardTagsInCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInCampaignFlowStepMetricResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentOriginResponse
object
3 properties
IconTypeInCampaignFlowStepResponse
The icon type as configured: a literal value, or an expression (type:string) when defined dynamically.
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableResponse
The allowed reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionScheduleResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
TransitionRuleResponse
object
5 properties
5 required
SumOfFaceValueMinInCampaignControllerTriggerHasPriorRewardResponse
The sum of face value min as configured: a literal value, or an expression (type:string) when defined dynamically.
IpThresholdInCampaignControllerTriggerMaxMindResponse
The ip threshold as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignFrontendControllerResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltComponentStringMapVariableResponse
object
11 required
RewardStatesInCampaignControllerTriggerRewardEventResponse
The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.
AudienceIdsInCampaignControllerTriggerAudienceMembershipEventResponse
The audience ids as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsRewardSupplierId
object
CampaignControllerTriggerScoreResponse
object
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
SuccessResponse
object
1 property
1 required
BuiltComponentComponentIdVariableResponse
object
11 required
ApiResponse
object
3 properties
DefaultInBuiltComponentSettingValues
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
DataMapInBuiltCampaignControllerActionEmailResponse
object
CampaignSummaryResponse
object
20 properties
20 required
ExpressionSettingFilterResponse
object
Stored expression setting filter definition. Field expression is unevaluated and appears in buildtime-evaluatable form.
2 required
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.
DataInBuiltCampaignControllerActionEarnRewardResponse
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.
BuiltCampaignComponentVariableResponse
object
10 properties
FilterTagsInCampaignControllerTriggerHasPriorRewardResponse
The filter tags as configured: a literal value, or an expression (type:string) when defined dynamically.
RateNameInCampaignFlowStepWordsResponse
The rate name as configured: a literal value, or an expression (type:string) when defined dynamically.
IconColorInCampaignFlowStepResponse
The icon color as configured: a literal value, or an expression (type:string) when defined dynamically.
EnInComponentSettingVariableValuesOpenApiDocumentation
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
CampaignControllerActionFireAsPersonResponse
object
BuiltComponentSettingValues
object
Open map of evaluated setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same s…
2 properties
BuiltCampaignControllerTriggerZoneStateResponse
object
13 required
FilterNamesInCampaignControllerTriggerHasPriorStepResponse
The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerStickyJourneyResponse
object
BuiltCampaignControllerActionResponse
CampaignControllerActionExpressionResponse
object
JourneyNamesInCampaignFrontendControllerResponse
The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsClientKey
object
CampaignComponentVariableResponseAsHtml
object
EventTypesInCampaignControllerTriggerAudienceMembershipEventResponse
The event types as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDataIntelligenceResponse
object
BuiltCampaignComponentResponse
object
19 properties
19 required
CategoryInCampaignFrontendControllerResponse
The category as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignFrontendControllerResponse
object
18 required
RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse
The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDisplayResponse
object
DefaultValueInStepDataResponse
The default value as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionFireAsPersonResponse
object
CampaignControllerTriggerAudienceMembershipEventResponse
object
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
CampaignControllerActionEmailResponse
object
CampaignControllerActionEarnRewardResponse
object
EnInBuiltComponentSettingValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
CampaignComponentVariableResponseAsRewardSupplierId
object
DataMapInCampaignControllerActionSignalResponse
object
BuiltCampaignStepResponseBase
object
10 properties
BuiltCampaignComponentVariableResponseAsWebhookId
object
CampaignComponentSettingResponse
6 required
DataMapInBuiltCampaignControllerActionSignalResponse
object
CampaignComponentPartnerEnumListVariableResponse
object
Stored campaign component partner enum list variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
EnabledOnStatesInCampaignControllerResponse
The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentTypeSettingFilterResponse
object
2 required
BuiltCampaignControllerActionExpressionResponse
object
8 required
ReviewStatusInCampaignControllerActionIncentivizeResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueInBuiltStepDataResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
MonthDay
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339appendix-A) month-day date.
DelaysInCampaignControllerActionScheduleResponse
The delays as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInCampaignControllerTriggerAudienceMembershipResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsBoolean
object
BuiltCampaignControllerResponse
object
19 required
CampaignControllerTriggerDataIntelligenceEventResponse
object
PersonIdInCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerResponse
Stored campaign controller trigger definition. Fields triggerphase, triggername, parenttriggergroupname, triggerdescription, enabled, and negated are unevaluat…
10 required
BuiltStepDataResponse
object
11 properties
11 required
FireAsPersonIdentification
BuiltCampaignControllerTriggerRewardEventResponse
object
14 required
CampaignComponentVariableResponseAsBrowserSideJavascript
object
DescriptionInCampaignComponentVariableResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerExpressionResponse
object
OperatorInCampaignControllerTriggerGroupResponse
The operator as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsFont
object
CampaignComponentVariableResponseAsAudienceId
object
CampaignControllerTriggerAudienceMembershipResponse
object
BuiltCampaignComponentVariableResponseAsImage
object
CampaignControllerTriggerLegacyLabelTargetingResponse
object
BuiltCampaignComponentVariableResponseAsExtoleClientKey
object
CampaignControllerTriggerTargetingResponse
object
SequenceInCampaignFlowStepResponse
The sequence as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionDisplayResponse
object
PartnerEnumListVariableOptionResponse
object
2 properties
BuiltCampaignComponentVariableResponseAsClientDomainIdList
object
CampaignControllerTriggerClientDomainResponse
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.
DisplayNameInCampaignComponentResponse
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerResponse
object
Stored campaign controller definition. Fields enabled, name, scope, enabledonstates, selectors, aliases, journeynames, sendpolicy, and stepbuilder are unevalua…
19 required
BuiltComponentPartnerEnumListVariableResponse
object
12 required
CampaignComponentVariableResponseAsStringList
object
CampaignControllerActionSignalResponse
object
CampaignMakeLatestRequest
object
2 properties
NegatedInCampaignControllerTriggerResponseBase
The negated as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterStatesInCampaignControllerTriggerHasPriorRewardResponse
The filter states as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInBuiltCampaignControllerTriggerHasPriorStepResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerResponseBase
object
10 properties
HeadersInBuiltCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
AliasesInCampaignControllerResponse
The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.
IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse
The incentivize action type as configured: a literal value, or an expression (type:string) when defined dynamically.
MessageInCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionExpressionResponse
object
BuiltCampaignControllerTriggerHasPriorRewardResponse
object
27 required
ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInBuiltCampaignControllerTriggerExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerEventTargetingResponse
object
CampaignComponentVariableResponseAsString
object
CountMaxInCampaignControllerTriggerHasPriorRewardResponse
The count max as configured: a literal value, or an expression (type:string) when defined dynamically.
UnitInCampaignFlowStepMetricResponse
The unit as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMinAgeInCampaignControllerTriggerHasPriorStepResponse
The filter min age 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.
ExpressionInCampaignControllerActionExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
StepNameInCampaignFlowStepResponse
The step name as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyNameInCampaignControllerTriggerJourneyCheckResponse
The journey name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsPersonKeyName
object
CampaignControllerTriggerResponseBase
object
10 properties
StepDataResponse
object
Stored step data definition. Fields name, value, scope, dimension, persisttypes, defaultvalue, keytype, and enabled are unevaluated and appear in buildtime-eva…
11 properties
11 required
AllowHighRiskEmailInCampaignControllerTriggerMaxMindResponse
The allow high risk email as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsGlobComponentPath
object
BuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
BuiltCampaignFlowStepAppTypeResponse
object
1 property
TagsInCampaignControllerTriggerRewardEventResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardNameInCampaignControllerActionEarnRewardResponse
The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerEventTargetingResponse
object
CampaignControllerActionRevokeRewardResponse
object
BuiltCampaignComponentVariableResponseAsInteger
object
BodyInCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionApproveResponse
object
InstallInBuiltCampaignComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionResponseBase
object
6 properties
FilterPartnerEventIdInCampaignControllerTriggerHasPriorStepResponse
The filter partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInStepDataResponse
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNameInCampaignControllerActionDataIntelligenceResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionScheduleResponse
object
12 required
ScopeInCampaignControllerTriggerTargetingResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsIntegerList
object
CampaignControllerTriggerRewardEventResponse
object
BuiltCampaignComponentVariableResponseAsAudienceIdList
object
IncentiveResponse
object
4 properties
4 required
CampaignControllerTriggerStepEventResponse
object
BuiltCampaignControllerTriggerSendRewardEventResponse
object
13 required
BuiltCampaignControllerTriggerLegacyLabelTargetingResponse
object
10 required
BuiltCampaignControllerTriggerLegacyQualityResponse
object
SendPolicyInCampaignFrontendControllerResponse
The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardStatesInCampaignControllerTriggerSendRewardEventResponse
The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.
WebhookIdInCampaignControllerActionWebhookResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInCampaignFlowStepResponse
The tags 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.
NameInBuiltCampaignControllerActionSignalResponse
The name 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…
CampaignControllerActionCreateMembershipResponse
object
EventTimeInCampaignControllerActionFulfillRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMinValueInCampaignControllerTriggerHasPriorStepResponse
The filter min value as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionFireAsPersonResponse
object
BuiltCampaignFlowStepMetricResponse
object
8 properties
8 required
ExpressionInCampaignControllerTriggerExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionApproveResponse
object
15 required
DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
BuiltCampaignControllerActionRemoveMembershipResponse
object
7 required
TagsInCampaignControllerTriggerSendRewardEventResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsAdminIcon
object
BuiltCampaignComponentVariableResponseAsJson
object
CampaignComponentVariableResponseAsJson
object
CampaignProgramLabelRenameRequest
object
1 property
1 required
PersonIdFireAsPersonIdentification
object
CampaignControllerTriggerHasIdentityResponse
object
HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse
The having all names as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionIncentivizeResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMinDateInCampaignControllerTriggerHasPriorRewardResponse
The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsDelayList
object
NameInJourneyKeyResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
VariantSelectorInCampaignResponse
The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignFlowStepMetricResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionFireAsPersonResponse
The data 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.
NameInCampaignFlowStepResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
DeweyDecimal
string
BuiltCampaignComponentSettingResponse
6 required
BuiltCampaignComponentVariableResponseAsDelay
object
DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsPersonKeyName
object
BuiltComponentPartnerEnumVariableResponse
object
12 required
EnabledInCampaignControllerTriggerResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignComponentVariableResponseAsHtml
object
HeadersInCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignLaunchBurstRequest
object
3 properties
CampaignComponentVariableResponseAsUrl
object
ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse
The profile risk update interval as configured: a literal value, or an expression (type:string) when defined dynamically.
WebhookIdInCampaignComponentPartnerEnumVariableResponse
The webhook id 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 Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Components API
Extole Components Grants API
Extole Components Settings API
Extole Components Subscriptions API
#Campaigns