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.2.0, 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), StepDataResponse (11 properties), BuiltStepDataResponse (11 properties), BuiltCampaignControllerTriggerResponseBase (10 properties). Each schema is shown below with its type and property counts.
SlotsInCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
EventNameInCampaignControllerActionFireAsPersonResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionResponse
Stored campaign controller action definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.
6 required
BuiltCampaignStepResponse
10 required
BodyInBuiltCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionEmailResponse
object
BuiltCampaignControllerTriggerAccessResponse
object
11 required
TriggerNameInCampaignControllerTriggerResponseBase
The trigger name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionExpressionResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerExpressionResponse
object
TaxYearStartInCampaignControllerTriggerHasPriorRewardResponse
The tax year start as configured: a literal value, or an expression (type:string) when defined dynamically.
DeweyDecimal
string
BuiltCampaignControllerTriggerRewardEventResponse
object
14 required
RewardTagsInCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerAudienceMembershipResponse
object
ExpressionInBuiltCampaignControllerTriggerExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
SendPolicyInCampaignFrontendControllerCreateRequest
Choose between static or dynamic send policy
CampaignControllerActionExpressionResponse
object
EventTimeInCampaignControllerActionRedeemRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
EnabledOnStatesInCampaignControllerCreateRequest
Choose between static or dynamic enabled on states
BuiltCampaignControllerActionWebhookResponse
object
8 required
SumOfFaceValueMinInCampaignControllerTriggerHasPriorRewardResponse
The sum of face value min as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueOfEventBeingRewardedInCampaignControllerActionEarnRewardResponse
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerCreateRequest
object
2 required
BodyInCampaignControllerActionDisplayResponse
The body as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseInCampaignControllerActionDisplayResponse
The response as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyNameInCampaignJourneyEntryCreateRequest
Choose between static or dynamic journey name
EventNamesInCampaignControllerTriggerRewardEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignStepResponseBase
object
10 properties
EnabledOnStatesInCampaignControllerResponse
The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.
SlotsInBuiltCampaignControllerActionEarnRewardResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionWebhookResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
HeadersInBuiltCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerSendRewardEventResponse
object
13 required
RewardStatesInCampaignControllerTriggerRewardEventResponse
The reward states as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerUserIdFireAsPersonIdentification
object
BuiltCampaignControllerTriggerLegacyQualityResponse
object
CampaignControllerTriggerHasIdentityResponse
object
CountMinInCampaignControllerTriggerHasPriorRewardResponse
The count min as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionCreateMembershipResponse
object
FilterMinValueInCampaignControllerTriggerHasPriorStepResponse
The filter min value as configured: a literal value, or an expression (type:string) when defined dynamically.
DefaultValueInBuiltStepDataResponse
The default value 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.
ScopeInCampaignFrontendControllerCreateRequest
Choose between static or dynamic scope
BuiltCampaignControllerActionDisplayResponse
object
NameInJourneyKeyCreateRequest
Choose between static or dynamic name
DataInBuiltCampaignControllerActionScheduleResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerTargetingResponse
object
EventTypeInCampaignControllerTriggerEventResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
StepBuilderInCampaignStepCreateRequestBase
Choose between static or dynamic step builder
CampaignControllerTriggerHasPriorRewardResponse
object
FilterScopeInCampaignControllerTriggerHasPriorStepResponse
The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
NameInCampaignFrontendControllerResponse
The name 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.
DataMapInBuiltCampaignControllerActionSignalResponse
object
CampaignControllerActionSignalResponse
object
BuiltCampaignControllerTriggerHasIdentityResponse
object
10 required
MessageInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionStepSignalResponse
object
TagsInBuiltCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionFireAsPersonResponse
object
PartnerEventIdFireAsPersonIdentification
object
ValueOfEventBeingRewardedInBuiltCampaignControllerActionEarnRewardResponse
The value of event being rewarded as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerGroupResponse
object
BuiltStepDataResponse
object
11 properties
11 required
BuiltCampaignControllerTriggerAudienceMembershipEventResponse
object
12 required
DatesInCampaignControllerActionScheduleResponse
The dates as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerShareResponse
object
CampaignControllerTriggerEventTargetingResponse
object
CampaignControllerActionDeclineResponse
object
StepBuilderInCampaignJourneyEntryCreateRequest
Choose between static or dynamic step builder
BuiltCampaignControllerActionIncentivizeResponse
object
PersonIdInBuiltCampaignControllerTriggerJourneyCheckResponse
The person id 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
FilterMinAgeInCampaignControllerTriggerHasPriorStepResponse
The filter min age as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignStepResponseBase
object
10 properties
SendPolicyInCampaignControllerResponse
The send policy 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.
AllowHighRiskEmailInCampaignControllerTriggerMaxMindResponse
The allow high risk email as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionExpressionResponse
object
EnabledInCampaignStepResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionDeclineResponse
object
13 required
NameInBuiltCampaignControllerActionSignalResponse
The name 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.
MessageInCampaignControllerActionIncentivizeStatusUpdateResponse
The message as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionEarnRewardResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerHasPriorStepResponse
object
35 required
JourneyNamesInCampaignControllerResponse
The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
EnabledInCampaignControllerActionResponseBase
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionSignalV1Response
object
8 required
ApiResponse
object
3 properties
ValueInJourneyKeyCreateRequest
Choose between static or dynamic value
FilterMinDateInCampaignControllerTriggerHasPriorStepResponse
The filter min date 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.
RewardActionIdInBuiltCampaignControllerActionEarnRewardResponse
The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.
SelectorsInCampaignControllerCreateRequest
Choose between static or dynamic selectors
ExpressionInCampaignControllerActionExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTypeInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The event type as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionApproveResponse
object
15 required
CampaignControllerTriggerReferredByEventResponse
object
RewardStatesInCampaignControllerTriggerSendRewardEventResponse
The reward states 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.
DataMapInCampaignControllerActionSignalResponse
object
FilterFaceValueTypesInCampaignControllerTriggerHasPriorRewardResponse
The filter face value types 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.
DataInCampaignControllerActionSignalResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionEarnRewardResponse
object
FilterRewardSupplierIdsInCampaignControllerTriggerHasPriorRewardResponse
The filter reward supplier ids 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.
CategoryInCampaignFrontendControllerCreateRequest
Choose between static or dynamic category
CampaignControllerTriggerJourneyCheckResponse
object
AudienceIdInCampaignControllerActionCreateMembershipResponse
The audience id 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.
DataMapInBuiltCampaignControllerActionIncentivizeResponse
object
JourneyKeyCreateRequest
object
2 properties
TriggerDescriptionInCampaignControllerTriggerResponseBase
The trigger description as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionEmailResponse
object
CampaignControllerTriggerZoneStateResponse
object
CampaignControllerTriggerLegacyQualityResponse
object
ReviewStatusInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInCampaignControllerActionEmailResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
DefaultValueInStepDataCreateRequest
Choose between static or dynamic default value
CampaignControllerTriggerEventResponse
object
ComponentReferenceResponse
object
2 properties
BuiltCampaignJourneyEntryResponse
object
13 required
RewardNameInCampaignControllerActionEarnRewardResponse
The reward name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerScoreResponse
object
13 required
CampaignStepResponse
10 required
PersonIdInCampaignControllerTriggerAudienceMembershipResponse
The person id 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.
ExtraDataInCampaignControllerActionScheduleResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionFireAsPersonResponse
object
CampaignControllerTriggerAccessResponse
object
DelaysInCampaignControllerActionScheduleResponse
The delays as configured: a literal value, or an expression (type:string) when defined dynamically.
ReviewStatusInCampaignControllerActionIncentivizeStatusUpdateResponse
The review status as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentReferenceRequest
object
2 properties
BuiltCampaignControllerActionEarnRewardResponse
object
14 required
EnabledOnStatesInCampaignFrontendControllerResponse
The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueInStepDataCreateRequest
Choose between static or dynamic value
TagsInCampaignControllerActionEarnRewardResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionRedeemRewardResponse
object
FilterMaxAgeInCampaignControllerTriggerHasPriorRewardResponse
The filter max age as configured: a literal value, or an expression (type:string) when defined dynamically.
StepBuilderInCampaignFrontendControllerCreateRequest
Choose between static or dynamic step builder
DataInCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInCampaignControllerTriggerJourneyCheckResponse
The person 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.
NegatedInCampaignControllerTriggerResponseBase
The negated 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.
DataInCampaignControllerActionScheduleResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
PartnerEventIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionEmailResponse
object
LegacyActionIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionCancelRewardResponse
object
TargetingAttributesInCampaignControllerTriggerEventTargetingResponse
The targeting attributes as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionDataIntelligenceResponse
object
9 required
LabelInCampaignControllerTriggerStickyJourneyResponse
The label as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdInBuiltCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerClientDomainResponse
object
11 required
BuiltCampaignControllerTriggerShareResponse
object
12 required
CampaignControllerTriggerAudienceMembershipEventResponse
object
BuiltCampaignControllerTriggerMaxMindResponse
object
14 required
SumOfValueMinInCampaignControllerTriggerHasPriorStepResponse
The sum of value min as configured: a literal value, or an expression (type:string) when defined dynamically.
JourneyKeyResponse
object
2 properties
DimensionInStepDataCreateRequest
Choose between static or dynamic dimension
ReviewStatusInCampaignControllerActionIncentivizeResponse
The review status 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.
FilterMinDateInCampaignControllerTriggerHasPriorRewardResponse
The filter min date as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInCampaignControllerActionFulfillRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionScheduleResponse
object
CampaignControllerTriggerStepEventResponse
object
BuiltCampaignControllerTriggerLegacyLabelTargetingResponse
object
10 required
ScopeInCampaignControllerResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
AliasesInCampaignControllerCreateRequest
Choose between static or dynamic aliases
ZoneNameInCampaignControllerTriggerZoneStateResponse
The zone name as configured: a literal value, or an expression (type:string) when defined dynamically.
PersistTypesInStepDataCreateRequest
Choose between static or dynamic persist types
MoveToPendingInCampaignControllerActionIncentivizeStatusUpdateResponse
The move to pending as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionExpressionResponse
object
8 required
HeadersInCampaignControllerActionDisplayResponse
The headers as configured: a literal value, or an expression (type:string) when defined dynamically.
DataInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionFulfillRewardResponse
object
DelaysInBuiltCampaignControllerActionScheduleResponse
The delays 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.
SlotsInCampaignControllerTriggerRewardEventResponse
The slots as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltJourneyKeyResponse
object
2 properties
ClientDomainIdsInCampaignControllerTriggerClientDomainResponse
The client domain ids as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueInBuiltJourneyKeyResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMaxDateInCampaignControllerTriggerHasPriorStepResponse
The filter max date 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.
LegacyActionIdInBuiltCampaignControllerActionIncentivizeStatusUpdateResponse
The legacy action id as configured: a literal value, or an expression (type:string) when defined dynamically.
RewardActionIdInCampaignControllerActionEarnRewardResponse
The reward action id as configured: a literal value, or an expression (type:string) when defined dynamically.
CountMaxInCampaignControllerTriggerHasPriorStepResponse
The count max as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerEventTargetingResponse
object
BuiltCampaignControllerTriggerDataIntelligenceEventResponse
object
11 required
DataMapInCampaignControllerActionEarnRewardResponse
object
CampaignFrontendControllerResponse
object
Stored campaign frontend controller definition. Fields enabled, name, scope, enabledonstates, category, aliases, journeynames, sendpolicy, and stepbuilder are…
18 required
BuiltCampaignControllerTriggerHasPriorRewardResponse
object
27 required
BuiltCampaignControllerActionRemoveMembershipResponse
object
7 required
BuiltCampaignControllerActionScheduleResponse
object
12 required
ScopeInStepDataCreateRequest
Choose between static or dynamic scope
CampaignStepCreateRequestBase
object
5 properties
OperatorInCampaignControllerTriggerGroupResponse
The operator as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerLegacyLabelTargetingResponse
object
ExpressionInBuiltCampaignControllerActionExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
StepBuilderInCampaignControllerCreateRequest
Choose between static or dynamic step builder
EnabledInCampaignControllerTriggerResponseBase
The enabled 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.
DataInCampaignControllerActionFireAsPersonResponse
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.
ScopeInCampaignControllerTriggerTargetingResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
ValueInJourneyKeyResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterMaxDateInCampaignControllerTriggerHasPriorRewardResponse
The filter max date as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInStepDataCreateRequest
Choose between static or dynamic name
PartnerEventId
object
2 properties
FilterExpressionInCampaignControllerTriggerHasPriorRewardResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerExpressionResponse
object
NameInCampaignControllerResponse
The name 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.
BuiltCampaignFrontendControllerResponse
object
18 required
EnabledOnStatesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic enabled on states
NameInCampaignControllerActionSignalResponse
The name 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.
CampaignFrontendControllerCreateRequest
object
2 required
CampaignControllerTriggerStickyJourneyResponse
object
FireAsPersonJourney
object
13 properties
RewardSupplierIdInCampaignControllerActionEarnRewardResponse
The reward supplier id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionIncentivizeResponse
object
RewardNamesInCampaignControllerTriggerSendRewardEventResponse
The reward names as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionScheduleResponse
object
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…
JourneyNameInCampaignJourneyEntryResponse
The journey name as configured: a literal value, or an expression (type:string) when defined dynamically.
NameInCampaignFrontendControllerCreateRequest
Choose between static or dynamic name
Duration
string
[RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545section-3.3.6) duration string.
DataInCampaignControllerActionIncentivizeResponse
The data 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.
CampaignControllerActionEmailResponse
object
CountMatchesInCampaignControllerTriggerHasPriorRewardResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
CategoryInCampaignFrontendControllerResponse
The category as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionIncentivizeResponse
object
DataMapInCampaignControllerActionIncentivizeStatusUpdateResponse
object
ZoneNameInCampaignControllerActionEmailResponse
The zone 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.
CampaignControllerTriggerRewardEventResponse
object
EmailFireAsPersonIdentification
object
ScheduleNameInCampaignControllerActionScheduleResponse
The schedule name 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.
CampaignControllerActionResponseBase
object
6 properties
FilterPartnerEventIdInCampaignControllerTriggerHasPriorStepResponse
The filter partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionStepSignalResponse
object
8 required
FilterExpressionInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter expression 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.
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
MonthDay
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339appendix-A) month-day date.
ActionTypeInCampaignControllerTriggerLegacyQualityResponse
The action type as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerResponse
object
19 required
EventNamesInCampaignControllerTriggerStepEventResponse
The event names as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInBuiltCampaignControllerActionScheduleResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerGroupResponse
object
BuiltCampaignControllerTriggerAudienceMembershipResponse
object
12 required
HavingAllNamesInBuiltCampaignControllerTriggerHasPriorStepResponse
The having all names as configured: a literal value, or an expression (type:string) when defined dynamically.
FireAsPersonIdentification
TagsInCampaignControllerTriggerSendRewardEventResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTimeInCampaignControllerActionEarnRewardResponse
The event time as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionCreateMembershipResponse
object
7 required
CampaignControllerActionShareEventResponse
object
ProfileRiskUpdateIntervalInCampaignControllerActionDataIntelligenceResponse
The profile risk update interval 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.
ExtraDataInCampaignControllerActionEarnRewardResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionIncentivizeStatusUpdateResponse
object
JourneyNamesInCampaignControllerCreateRequest
Choose between static or dynamic journey names
PersonIdInCampaignControllerActionFireAsPersonResponse
The person id as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerStepEventResponse
object
IntelligenceProviderInCampaignControllerActionDataIntelligenceResponse
The intelligence provider as configured: a literal value, or an expression (type:string) when defined dynamically.
PersonIdFireAsPersonIdentification
object
SumOfValueMaxInCampaignControllerTriggerHasPriorStepResponse
The sum of value max 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.
FilterCampaignIdsInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.
CountMatchesInCampaignControllerTriggerHasPriorStepResponse
The count matches as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionFulfillRewardResponse
object
10 required
JourneyNamesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic journey names
BuiltCampaignControllerActionRevokeRewardResponse
object
8 required
DataInBuiltCampaignControllerActionWebhookResponse
The 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.
IpThresholdInCampaignControllerTriggerMaxMindResponse
The ip threshold as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterNamesInCampaignControllerTriggerHasPriorStepResponse
The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionCreativeResponse
object
12 required
FilterProgramLabelsInBuiltCampaignControllerTriggerHasPriorStepResponse
The filter program labels as configured: a literal value, or an expression (type:string) when defined dynamically.
StepNameInCampaignControllerTriggerZoneStateResponse
The step name as configured: a literal value, or an expression (type:string) when defined dynamically.
SelectorsInCampaignControllerResponse
The selectors 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.
BuiltCampaignControllerActionIncentivizeStatusUpdateResponse
object
FireAsPersonIdentificationBase
object
2 properties
EventTimeInBuiltCampaignControllerActionFireAsPersonResponse
The event time 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.
SignalPollingIdInBuiltCampaignControllerActionSignalResponse
The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterScopeInCampaignControllerTriggerHasPriorRewardResponse
The filter scope as configured: a literal value, or an expression (type:string) when defined dynamically.
PersistTypesInStepDataResponse
The persist types as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerScoreResponse
object
EventNameInCampaignControllerActionDataIntelligenceResponse
The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInCampaignControllerActionScheduleResponse
object
CampaignControllerTriggerSendRewardEventResponse
object
ScopeInCampaignControllerCreateRequest
Choose between static or dynamic scope
CampaignControllerActionRevokeRewardResponse
object
BuiltCampaignControllerTriggerReferredByEventResponse
object
11 required
JourneyNamesInCampaignFrontendControllerResponse
The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionApproveResponse
object
TriggerPhaseInCampaignControllerTriggerResponseBase
The trigger phase as configured: a literal value, or an expression (type:string) when defined dynamically.
FilterCampaignIdsInCampaignControllerTriggerHasPriorStepResponse
The filter campaign ids as configured: a literal value, or an expression (type:string) when defined dynamically.
TagsInCampaignControllerTriggerRewardEventResponse
The tags as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerClientDomainResponse
object
BuiltCampaignControllerTriggerResponse
10 required
CampaignControllerTriggerMaxMindResponse
object
CampaignJourneyEntryResponse
object
Stored campaign journey entry definition. Fields enabled, journeyname, priority, and stepbuilder are unevaluated and appear in buildtime-evaluatable form.
13 required
DatesInBuiltCampaignControllerActionScheduleResponse
The dates 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.
ScopeInStepDataResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerStickyJourneyResponse
object
CampaignControllerActionWebhookResponse
object
AliasesInCampaignFrontendControllerCreateRequest
Choose between static or dynamic aliases
BuiltCampaignControllerTriggerResponseBase
object
10 properties
PriorityInCampaignJourneyEntryCreateRequest
Choose between static or dynamic priority
DataMapInCampaignControllerActionFireAsPersonResponse
object
WebhookIdInCampaignControllerActionWebhookResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
ResponseInBuiltCampaignControllerActionDisplayResponse
The response 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.
DataInBuiltCampaignControllerActionFireAsPersonResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionResponse
PartnerEventIdInCampaignControllerActionIncentivizeStatusUpdateResponse
The partner event id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerHasPriorStepResponse
object
SendPolicyInCampaignControllerCreateRequest
Choose between static or dynamic send policy
FilterQualityInCampaignControllerTriggerHasPriorStepResponse
The filter quality as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionEarnRewardResponse
object
PersonIdInCampaignControllerTriggerHasPriorStepResponse
The person 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.
CampaignControllerActionSignalV1Response
object
BuiltCampaignControllerTriggerEventResponse
object
EnabledInCampaignStepCreateRequestBase
Choose between static or dynamic enabled
EventTypeInCampaignControllerActionIncentivizeStatusUpdateResponse
The event type 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
EventNamesInCampaignControllerTriggerEventResponse
The event names 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.
DataMapInCampaignControllerActionExpressionResponse
object
DataInCampaignControllerActionEarnRewardResponse
The data as configured: a literal value, or an expression (type:string) when defined dynamically.
SignalPollingIdInCampaignControllerActionSignalResponse
The signal polling id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionDisplayResponse
object
FilterMinAgeInCampaignControllerTriggerHasPriorRewardResponse
The filter min age as configured: a literal value, or an expression (type:string) when defined dynamically.
DataMapInBuiltCampaignControllerActionWebhookResponse
object
BuiltCampaignControllerActionRedeemRewardResponse
object
9 required
DataMapInCampaignControllerActionWebhookResponse
object
NameInStepDataResponse
The name as configured: a literal value, or an expression (type:string) when defined dynamically.
ExtraDataInBuiltCampaignControllerActionFireAsPersonResponse
The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerJourneyCheckResponse
object
EnabledInStepDataCreateRequest
Choose between static or dynamic enabled
CountMaxInCampaignControllerTriggerHasPriorRewardResponse
The count max as configured: a literal value, or an expression (type:string) when defined dynamically.
StepDataCreateRequest
object
Body of a POST /v2/campaigns/{campaignId}{version:(/version/.+)?}/steps/{stepId}/data request.
10 properties
2 required
BuiltCampaignControllerActionResponseBase
object
6 properties
CampaignControllerActionDataIntelligenceResponse
object
CampaignControllerTriggerResponseBase
object
10 properties
ScopeInCampaignFrontendControllerResponse
The scope as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerTriggerZoneStateResponse
object
13 required
RiskThresholdInCampaignControllerTriggerMaxMindResponse
The risk threshold as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerTargetingResponse
object
AudienceIdsInCampaignControllerTriggerAudienceMembershipEventResponse
The audience ids 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
IncentivizeActionTypeInCampaignControllerActionIncentivizeResponse
The incentivize action type 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.
ScheduleNameInBuiltCampaignControllerActionScheduleResponse
The schedule name as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionCancelRewardResponse
object
8 required
KeyTypeInStepDataResponse
The key type as configured: a literal value, or an expression (type:string) when defined dynamically.
ExpressionInCampaignControllerTriggerExpressionResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
AliasesInCampaignFrontendControllerResponse
The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionCreativeResponse
object
NameInCampaignControllerCreateRequest
Choose between static or dynamic name
ValueInStepDataResponse
The value as configured: a literal value, or an expression (type:string) when defined dynamically.
EventTypesInCampaignControllerTriggerAudienceMembershipEventResponse
The event types as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerActionRemoveMembershipResponse
object
RewardTagsInBuiltCampaignControllerActionApproveResponse
The reward tags as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionShareEventResponse
object
6 required
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
DefaultValueInStepDataResponse
The default value as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignControllerTriggerDataIntelligenceEventResponse
object
BuiltCampaignControllerActionFireAsPersonResponse
object
FilterNamesInCampaignControllerTriggerHasPriorRewardResponse
The filter names as configured: a literal value, or an expression (type:string) when defined dynamically.
KeyTypeInStepDataCreateRequest
Choose between static or dynamic key type
DimensionInStepDataResponse
The dimension as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltCampaignControllerActionSignalResponse
object
9 required
CampaignJourneyEntryCreateRequest
object
1 required
SendPolicyInCampaignFrontendControllerResponse
The send policy 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.
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
Where this information came from
This is an independent, third-party profile of Extole Campaign Controllers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.