Extole Campaign Controllers API
The Campaign Controllers API from Extole — 2 operation(s) for campaign controllers.
Extole Campaign Controllers 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. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 3 operations across 2 paths, and defines 390 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.
3 operations
2 paths
390 schemas
2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Campaign Controllers 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 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Campaign Controllers 3
GET
/v2/campaigns/{campaignId}{version}/controllers
List campaign controllers
POST
/v2/campaigns/{campaignId}{version}/controllers
Create a campaign controller
GET
/v2/campaigns/{campaignId}{version}/controllers/built
List built campaign controllers
Schemas 390
The contract defines 390 schemas that model the data the API accepts and returns. The most detailed are FireAsPersonJourney (13 properties), BuiltStepDataResponse (11 properties), StepDataResponse (11 properties), CampaignControllerTriggerResponseBase (10 properties). Each schema is shown below with its type and property counts.
ValueInBuiltJourneyKeyResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
TagsInBuiltCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
PriorityInCampaignJourneyEntryCreateRequest
Choose between static or dynamic priority
ResponseInCampaignControllerActionDisplayResponse
The response 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
KeyTypeInStepDataCreateRequest
Choose between static or dynamic key type
BuiltCampaignStepResponse
10 required
DelaysInBuiltCampaignControllerActionScheduleResponse
The delays as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerAccessResponse
object
11 required
StepDataCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/steps/{stepId}/data request.
10 properties
2 required
ScheduleNameInCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
StepBuilderInCampaignControllerCreateRequest
Choose between static or dynamic step builder
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.
ScheduleNameInBuiltCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignControllerResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
EventNamesInCampaignControllerTriggerRewardEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignStepCreateRequest
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/controllers request.
1 required
BuiltCampaignControllerActionCreativeResponse
object
12 required
ExtraDataInCampaignControllerActionScheduleResponse
The extra data 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.
BuiltCampaignControllerActionDeclineResponse
object
13 required
BuiltCampaignControllerTriggerMaxMindResponse
object
14 required
FilterMinDateInCampaignControllerTriggerHasPriorStepResponse
The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerEventResponse
object
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.
BuiltCampaignControllerTriggerStepEventResponse
object
FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
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
EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
CategoryInCampaignFrontendControllerCreateRequest
Choose between static or dynamic category
SlotsInBuiltCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInCampaignControllerTriggerHasPriorStepResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionDataIntelligenceResponse
object
9 required
ScopeInStepDataCreateRequest
Choose between static or dynamic scope
RewardTagsInBuiltCampaignControllerActionApproveResponse
The reward tags 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.
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.
CampaignControllerActionCreativeResponse
object
AliasesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic aliases
DataInCampaignControllerActionWebhookResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionSignalResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerHasPriorRewardResponse
object
CampaignControllerCreateRequest
object
2 required
DataMapInCampaignControllerActionEarnRewardResponse
object
DataMapInBuiltCampaignControllerActionExpressionResponse
object
EnabledOnStatesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic enabled on states
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.
ZoneNameInCampaignControllerActionEmailResponse
The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerReferredByEventResponse
object
11 required
FireAsPersonIdentificationBase
object
2 properties
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.
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
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
CampaignControllerActionRemoveMembershipResponse
object
FilterMaxDateInCampaignControllerTriggerHasPriorStepResponse
The filter max date 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.
HavingAnyDataNameInCampaignControllerTriggerStepEventResponse
The having any data name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionFireAsPersonResponse
object
CountMatchesInCampaignControllerTriggerHasPriorStepResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
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
FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerExpressionResponse
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.
FilterScopeInCampaignControllerTriggerHasPriorStepResponse
The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse
object
BuiltCampaignControllerActionRedeemRewardResponse
object
9 required
RewardNamesInCampaignControllerTriggerSendRewardEventResponse
The reward names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerResponse
10 required
CampaignControllerActionRedeemRewardResponse
object
PartnerUserIdFireAsPersonIdentification
object
TriggerNameInCampaignControllerTriggerResponseBase
The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionSignalV1Response
object
CampaignControllerTriggerZoneStateResponse
object
BuiltCampaignControllerActionShareEventResponse
object
6 required
PersistTypesInStepDataResponse
The persist types 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.
FilterExpressionInCampaignControllerTriggerHasPriorRewardResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNamesInCampaignControllerTriggerStepEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
EnabledOnStatesInCampaignControllerCreateRequest
Choose between static or dynamic enabled on states
SumOfValueMinInCampaignControllerTriggerHasPriorStepResponse
The sum of value min as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionFulfillRewardResponse
object
NameInStepDataCreateRequest
Choose between static or dynamic name
PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterExpressionInCampaignControllerTriggerHasPriorStepResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerReferredByEventResponse
object
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.
JourneyKeyCreateRequest
object
2 properties
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.
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
DataInCampaignControllerActionIncentivizeResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignStepCreateRequestBase
Choose between static or dynamic enabled
CampaignControllerActionWebhookResponse
object
BuiltCampaignControllerActionEarnRewardResponse
object
14 required
DatesInBuiltCampaignControllerActionScheduleResponse
The dates as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionResponseBase
object
6 properties
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.
DataMapInBuiltCampaignControllerActionEarnRewardResponse
object
BuiltCampaignControllerActionIncentivizeResponse
object
DefaultValueInBuiltStepDataResponse
The default value as configured: a literal value, or an expression (type:string) when defined dynamically.
StepBuilderInCampaignJourneyEntryCreateRequest
Choose between static or dynamic step builder
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.
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.
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.
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
PersistTypesInStepDataCreateRequest
Choose between static or dynamic persist types
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.
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.
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
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.
SendPolicyInCampaignControllerCreateRequest
Choose between static or dynamic send policy
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
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
SelectorsInCampaignControllerResponse
The selectors as configured: a literal value, or an expression (type:string) when defined dynamically.
BodyInBuiltCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
ScopeInCampaignFrontendControllerCreateRequest
Choose between static or dynamic scope
EmailFireAsPersonIdentification
object
DataInCampaignControllerActionExpressionResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionIncentivizeResponse
object
BuiltCampaignJourneyEntryResponse
object
13 required
EventTimeInCampaignControllerActionRedeemRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyNamesInCampaignControllerCreateRequest
Choose between static or dynamic journey names
CampaignJourneyEntryResponse
object
Stored campaign journey entry definition. Fields enabled, journeyname, priority, and stepbuilder are unevaluated and appear in buildtime-evaluatable form.
13 required
CountMatchesInCampaignControllerTriggerHasPriorRewardResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionScheduleResponse
object
StepBuilderInCampaignFrontendControllerCreateRequest
Choose between static or dynamic step builder
ClientDomainIdsInCampaignControllerTriggerClientDomainResponse
The client domain ids as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardTagsInCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyNameInCampaignJourneyEntryCreateRequest
Choose between static or dynamic journey name
IpThresholdInCampaignControllerTriggerMaxMindResponse
The ip threshold 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.
SumOfFaceValueMinInCampaignControllerTriggerHasPriorRewardResponse
The sum of face value min 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.
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.
CampaignControllerTriggerScoreResponse
object
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
ApiResponse
object
3 properties
DataMapInBuiltCampaignControllerActionEmailResponse
object
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.
FilterTagsInCampaignControllerTriggerHasPriorRewardResponse
The filter tags as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignControllerCreateRequest
Choose between static or dynamic name
CampaignControllerActionFireAsPersonResponse
object
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.
CampaignFrontendControllerCreateRequest
object
2 required
EventTypesInCampaignControllerTriggerAudienceMembershipEventResponse
The event types as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDataIntelligenceResponse
object
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
ScopeInCampaignControllerCreateRequest
Choose between static or dynamic scope
CampaignControllerTriggerAudienceMembershipEventResponse
object
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
CampaignControllerActionEmailResponse
object
CampaignControllerActionEarnRewardResponse
object
DataMapInCampaignControllerActionSignalResponse
object
BuiltCampaignStepResponseBase
object
10 properties
DataMapInBuiltCampaignControllerActionSignalResponse
object
ComponentReferenceRequest
object
2 properties
EnabledOnStatesInCampaignControllerResponse
The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.
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.
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
JourneyNamesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic journey names
BuiltCampaignControllerTriggerExpressionResponse
object
AliasesInCampaignControllerCreateRequest
Choose between static or dynamic aliases
OperatorInCampaignControllerTriggerGroupResponse
The operator as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerAudienceMembershipResponse
object
CampaignControllerTriggerLegacyLabelTargetingResponse
object
CampaignControllerTriggerTargetingResponse
object
BuiltCampaignControllerActionDisplayResponse
object
CampaignControllerTriggerClientDomainResponse
object
ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
SendPolicyInCampaignFrontendControllerCreateRequest
Choose between static or dynamic send policy
BuiltCampaignControllerActionEmailResponse
object
DatesInCampaignControllerActionScheduleResponse
The dates 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
DefaultValueInStepDataCreateRequest
Choose between static or dynamic default value
CampaignControllerActionSignalResponse
object
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.
CampaignJourneyEntryCreateRequest
object
1 required
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.
CampaignStepCreateRequestBase
object
5 properties
ExpressionInBuiltCampaignControllerTriggerExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerEventTargetingResponse
object
StepBuilderInCampaignStepCreateRequestBase
Choose between static or dynamic step builder
CountMaxInCampaignControllerTriggerHasPriorRewardResponse
The count max as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInJourneyKeyCreateRequest
Choose between static or dynamic name
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.
ValueInJourneyKeyCreateRequest
Choose between static or dynamic value
ExpressionInCampaignControllerActionExpressionResponse
The expression 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.
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.
BuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
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
EnabledInStepDataCreateRequest
Choose between static or dynamic enabled
CampaignControllerActionRevokeRewardResponse
object
BodyInCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionApproveResponse
object
NameInCampaignFrontendControllerCreateRequest
Choose between static or dynamic name
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.
CampaignControllerTriggerRewardEventResponse
object
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.
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…
SelectorsInCampaignControllerCreateRequest
Choose between static or dynamic selectors
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
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.
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.
NameInJourneyKeyResponse
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.
DimensionInStepDataCreateRequest
Choose between static or dynamic dimension
DeweyDecimal
string
DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledInCampaignControllerTriggerResponseBase
The enabled 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.
ValueInStepDataCreateRequest
Choose between static or dynamic value
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 Actions 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