The identity and technical contract details declared by the specification.
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableRequest
Choose between static or dynamic allowed reward supplier ids
DescriptionInCampaignComponentVariableRequestAsDelayList
Choose between static or dynamic description
BatchComponentVariableValues
object
4 properties
ComponentDisplayNameInComponentDuplicateRequest
Choose between static or dynamic component display name
ComponentSettingVariableValuesAsStringList
object
BatchComponentVariableUpdateResponse
object
5 properties
5 required
CampaignComponentVariableResponseAsHtml
object
ComponentSettingVariableValuesAsBrowserSideJavascript
object
ComponentAssetResponse
object
5 properties
ComponentTypeSettingFilterCreateRequest
object
2 required
CampaignComponentSocketResponseAsMultiSocket
object
Stored campaign component socket definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
DescriptionInCampaignComponentRewardSupplierIdListVariableRequest
Choose between static or dynamic description
BuiltComponentSocketResponseAsMultiSocket
object
9 required
BuiltCampaignComponentVariableResponseAsClientDomainIdList
object
InstallInComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponse
object
8 properties
WebhookIdInCampaignComponentPartnerEnumVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsRewardSupplierId
object
DescriptionInCampaignComponentVariableResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentSettingVariableValuesAsRewardSupplierId
object
DefaultInBuiltComponentSettingValues
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
BuiltCampaignComponentVariableResponse
object
10 properties
BuiltCampaignComponentVariableResponseAsExtoleClientKey
object
ComponentSettingVariableValuesAsDelayList
object
CampaignComponentSocketRequestAsSocket
object
2 required
FileAttributes
object
2 properties
CampaignComponentVariableResponseAsAdminIcon
object
CampaignComponentRewardSupplierIdListVariableResponse
object
Stored campaign component reward supplier id list variable definition. Fields description and allowedrewardsupplierids are unevaluated and appear in buildtime-…
9 required
ExpressionSettingFilterCreateRequest
object
2 required
CampaignComponentVariableResponseAsAudienceId
object
ComponentSettingVariableValuesAsCss
object
CampaignComponentSettingResponse
6 required
DisplayNameInComponentResponse
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentSettingDiffResponse
object
3 properties
CampaignComponentVariableResponseAsUrl
object
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableRequest
Choose between static or dynamic captured setting values description
ComponentOriginResponse
object
3 properties
BuiltCampaignComponentVariableResponseAsAudienceId
object
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
CampaignComponentSocketRequestAsMultiSocket
object
2 required
DescriptionInCampaignComponentVariableRequestAsIntegerList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsClientDomainIdList
Choose between static or dynamic description
CampaignComponentVariableResponseAsColor
object
ValuesInCampaignComponentVariableRequestAsPersonKeyName
Choose between static or dynamic values
ValuesInCampaignComponentVariableRequestAsGlobComponentPath
Choose between static or dynamic values
DescriptionInCampaignComponentVariableRequestAsUrl
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsAudienceIdList
Choose between static or dynamic description
BuiltComponentPartnerEnumListVariableResponse
object
12 required
CampaignComponentComponentSettingLookupVariableRequest
object
3 required
BuiltCampaignComponentSettingResponse
6 required
DescriptionInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic description
PartnerEnumListVariableOptionResponse
object
2 properties
ValuesInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic values
ComponentSettingVariableValuesAsUrl
object
CampaignComponentFacetResponse
object
2 properties
BuiltCampaignComponentVariableResponseAsDelayList
object
ComponentTypeSettingFilterResponse
object
2 required
CampaignComponentVariableRequestAsStringList
object
BuiltCampaignComponentVariableResponseAsAudienceIdList
object
BuiltCampaignComponentVariableResponseAsBoolean
object
BuiltCampaignComponentVariableResponseAsFont
object
ValuesInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic values
CampaignComponentVariableRequestAsJson
object
DescriptionInCampaignComponentVariableRequestAsClientKey
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsInteger
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsStringList
object
CampaignComponentVariableRequestAsHtml
object
BuiltComponentRewardSupplierIdListVariableResponse
object
11 required
CampaignComponentVariableResponseAsGlobComponentPath
object
CampaignComponentVariableRequestAsClientKey
object
BuiltCampaignComponentVariableResponseAsDelay
object
ValuesInCampaignComponentVariableRequestAsAudienceIdList
Choose between static or dynamic values
ComponentSettingVariableValues
object
Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for t…
2 properties
BuiltCampaignComponentVariableResponseAsImage
object
ValuesInCampaignComponentVariableRequestAsStringList
Choose between static or dynamic values
ComponentReferenceResponse
object
2 properties
BuiltComponentSocketResponseAsSocket
object
9 required
CampaignComponentVariableResponseAsString
object
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableResponse
The allowed reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically.
ValuesInCampaignComponentVariableRequestAsWebhookId
Choose between static or dynamic values
DescriptionInCampaignComponentVariableRequestAsColor
Choose between static or dynamic description
ComponentReferenceRequest
object
2 properties
ValuesInCampaignComponentVariableRequestAsAdminIcon
Choose between static or dynamic values
DescriptionInCampaignComponentSocketRequestAsSocket
Choose between static or dynamic description
CampaignComponentEnumListVariableRequest
object
2 required
ValuesInCampaignComponentVariableRequestAsAudienceId
Choose between static or dynamic values
CampaignComponentVariableResponseAsImage
object
BuiltCampaignComponentVariableResponseAsAdminIcon
object
CampaignComponentComponentIdVariableResponse
object
Stored campaign component component id variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
EnInComponentSettingVariableValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
ComponentAssetCreateRequest
object
Body of a POST /v1/components/{componentid}/assets request.
3 properties
DescriptionInCampaignComponentEnumListVariableRequest
Choose between static or dynamic description
InstallInBuiltComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignComponentVariableRequestAsGlobComponentPath
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequest
Choose between static or dynamic description
ComponentFacetCreateRequest
object
Body of a POST /v1/component-facets request.
3 properties
3 required
CampaignComponentVariableResponseAsClientDomainIdList
object
DescriptionInCampaignComponentVariableRequestAsBoolean
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsUrl
object
CampaignComponentVariableRequestAsDelayList
object
ValuesInCampaignComponentVariableRequestAsClientKey
Choose between static or dynamic values
SettingFilterCreateRequestBase
object
1 property
BuiltCampaignComponentVariableResponseAsCss
object
CampaignComponentVariableRequestAsPersonKeyName
object
ValuesInCampaignComponentVariableRequestAsDelayList
Choose between static or dynamic values
ComponentSettingVariableValuesAsString
object
CampaignComponentVariableRequestAsImage
object
ComponentSettingVariableValuesAsIntegerList
object
ValuesInCampaignComponentVariableRequestAsString
Choose between static or dynamic values
EnInBuiltComponentSettingValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
CampaignComponentVariableRequestAsBoolean
object
CampaignComponentEnumListVariableResponse
object
Stored campaign component enum list variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
DescriptionInCampaignComponentVariableRequestAsHtml
Choose between static or dynamic description
CampaignComponentVariableResponseAsIntegerList
object
BuiltComponentEnumVariableResponse
object
11 required
DefaultInComponentSettingVariableValues
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
DescriptionInCampaignComponentPartnerEnumVariableRequest
Choose between static or dynamic description
AnchorRequest
object
2 properties
CampaignComponentStringMapVariableResponse
object
Stored campaign component string map variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
CampaignComponentVariableResponseAsInteger
object
ComponentSettingVariableValuesAsClientDomainIdList
object
CampaignComponentVariableRequestAsIntegerList
object
DescriptionInCampaignComponentVariableRequestAsAudienceId
Choose between static or dynamic description
BuiltComponentEnumListVariableResponse
object
11 required
BuiltComponentComponentSettingLookupVariableResponse
object
14 required
ValuesInCampaignComponentVariableRequestAsInteger
Choose between static or dynamic values
CampaignComponentVariableRequestAsDelay
object
CampaignComponentVariableRequest
object
8 properties
ValuesInCampaignComponentVariableRequestAsImage
Choose between static or dynamic values
FileInputStreamRequest
object
2 properties
2 required
DescriptionInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic description
CampaignComponentSettingResponseBase
object
6 properties
BuiltComponentStringMapVariableResponse
object
11 required
BuiltCampaignComponentVariableResponseAsString
object
CampaignComponentVariableResponseAsBoolean
object
ComponentSettingVariableValuesAsInteger
object
ComponentSettingVariableValuesAsHtml
object
BuiltCampaignComponentVariableResponseAsHtml
object
ComponentSettingVariableValuesAsAdminIcon
object
CampaignComponentVariableRequestAsAudienceIdList
object
CampaignComponentVariableRequestAsExtoleClientKey
object
BuiltCampaignComponentVariableResponseAsGlobComponentPath
object
CampaignComponentVariableRequestAsAdminIcon
object
BuiltCampaignComponentVariableResponseAsRewardSupplierId
object
ValuesInCampaignComponentVariableRequestAsExtoleClientKey
Choose between static or dynamic values
CampaignComponentStringMapVariableRequest
object
2 required
ComponentSettingVariableValuesAsDelay
object
ComponentIdFilterCreateRequest
object
1 property
ValuesInCampaignComponentVariableRequestAsJson
Choose between static or dynamic values
ComponentFacetAllowedValueUpdateRequest
object
5 properties
CampaignComponentPartnerEnumListVariableResponse
object
Stored campaign component partner enum list variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
DescriptionInCampaignComponentVariableRequestAsPersonKeyName
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsJson
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsBoolean
Choose between static or dynamic values
EnInComponentSettingVariableValuesOpenApiDocumentation
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
WebhookIdInCampaignComponentPartnerEnumListVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignComponentVariableRequestAsImage
Choose between static or dynamic description
ComponentSettingVariableValuesAsImage
object
FormDataContentDisposition
object
8 properties
CampaignComponentPartnerEnumVariableRequest
object
2 required
BuiltCampaignComponentSettingResponseBase
object
6 properties
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…
DescriptionInCampaignComponentClientKeyFlowVariableRequest
Choose between static or dynamic description
ExpressionSettingFilterResponse
object
Stored expression setting filter definition. Field expression is unevaluated and appears in buildtime-evaluatable form.
2 required
ValuesInCampaignComponentVariableRequestAsHtml
Choose between static or dynamic values
DescriptionInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic description
CampaignComponentVariableResponseAsClientKey
object
CampaignComponentEnumVariableResponse
object
Stored campaign component enum variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
ValuesInCampaignComponentVariableRequestAsCss
Choose between static or dynamic values
CampaignComponentSocketResponseAsSocket
object
Stored campaign component socket definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
ComponentSettingVariableValuesAsJson
object
DescriptionInCampaignComponentSettingResponseBase
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsFont
object
BuiltComponentAssetResponse
object
5 properties
5 required
CampaignComponentVariableRequestAsString
object
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableResponse
The captured setting values description as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsExtoleClientKey
object
CampaignComponentVariableRequestAsFont
object
BuiltComponentResponse
object
24 properties
24 required
ComponentFacetSettingFilterCreateRequest
object
3 required
CampaignComponentComponentSettingLookupVariableResponse
object
Stored campaign component component setting lookup variable definition. Fields description and capturedsettingvaluesdescription are unevaluated and appear in b…
12 required
DescriptionInCampaignComponentVariableRequestAsAdminIcon
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsWebhookId
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsBrowserSideJavascript
object
CampaignComponentPartnerEnumVariableResponse
object
Stored campaign component partner enum variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
PartnerEnumListVariableOptionCreateRequest
object
2 properties
CampaignComponentRewardSupplierIdListVariableRequest
object
2 required
ComponentAvailableUpgradeResponse
object
3 properties
3 required
BuiltComponentSettingValues
object
Open map of evaluated setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same s…
2 properties
ComponentFacetSettingFilterResponse
object
3 required
BuiltCampaignComponentVariableResponseAsIntegerList
object
ComponentSettingVariableValuesAsAudienceIdList
object
CampaignComponentEnumVariableRequest
object
2 required
ValuesInCampaignComponentVariableRequestAsIntegerList
Choose between static or dynamic values
ExpressionInExpressionSettingFilterResponse
The expression as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsDelayList
object
DescriptionInCampaignComponentPartnerEnumListVariableRequest
Choose between static or dynamic description
CampaignComponentVariableResponseAsBrowserSideJavascript
object
WebhookIdInCampaignComponentPartnerEnumVariableRequest
Choose between static or dynamic webhook id
ValuesInCampaignComponentVariableRequestAsColor
Choose between static or dynamic values
ExpressionInExpressionSettingFilterCreateRequest
Choose between static or dynamic expression
ComponentFacetAllowedValueResponse
object
Allowed value for a component category, including optional display metadata.
5 properties
CampaignComponentSettingRequestBase
object
5 properties
CampaignComponentVariableRequestAsCss
object
CampaignComponentVariableResponseAsStringList
object
BuiltComponentComponentIdVariableResponse
object
11 required
CampaignComponentComponentIdVariableRequest
object
2 required
ComponentResponse
object
Stored component definition. Field displayname is unevaluated and appears in buildtime-evaluatable form.
23 properties
23 required
ComponentSettingVariableValuesAsColor
object
ComponentAssetUpdateRequest
object
Body of a PUT /v1/components/{componentid}/assets/{assetid} request.
3 properties
DescriptionInCampaignComponentComponentIdVariableRequest
Choose between static or dynamic description
CampaignComponentVariableRequestAsWebhookId
object
DefaultInComponentSettingVariableValuesOpenApiDocumentation
Example value key. Fallback when no locale- or environment-specific key matches. Omitting default is valid when another key applies.
DescriptionInCampaignComponentVariableRequestAsExtoleClientKey
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsJson
object
CampaignComponentClientKeyFlowVariableResponse
object
Stored campaign component client key flow variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
11 required
AnchorDetailsResponse
object
2 properties
2 required
BuiltComponentPartnerEnumVariableResponse
object
12 required
ComponentSettingVariableValuesAsGlobComponentPath
object
ComponentFacetAllowedValueCreateRequest
object
5 properties
CampaignComponentVariableRequestAsRewardSupplierId
object
CampaignComponentVariableRequestAsAudienceId
object
CampaignComponentVariableRequestAsBrowserSideJavascript
object
ValuesInCampaignComponentVariableRequestAsUrl
Choose between static or dynamic values
BuiltCampaignComponentVariableResponseAsClientKey
object
ComponentSettingVariableValuesAsFont
object
BuiltCampaignComponentVariableResponseAsWebhookId
object
DescriptionInCampaignComponentSocketRequestAsMultiSocket
Choose between static or dynamic description
ComponentSettingVariableValuesAsWebhookId
object
BuiltCampaignComponentVariableResponseAsPersonKeyName
object
DescriptionInCampaignComponentStringMapVariableRequest
Choose between static or dynamic description
BuiltComponentClientKeyFlowVariableResponse
object
13 required
SettingFilterCreateRequest
ComponentSettingVariableValuesAsAudienceId
object
DescriptionInCampaignComponentVariableRequestAsCss
Choose between static or dynamic description
CampaignComponentVariableResponseAsAudienceIdList
object
DescriptionInCampaignComponentComponentSettingLookupVariableRequest
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsColor
object
CampaignComponentVariableResponseAsPersonKeyName
object
ComponentIdFilterResponse
object
1 property
WebhookIdInCampaignComponentPartnerEnumListVariableRequest
Choose between static or dynamic webhook id
CampaignComponentPartnerEnumListVariableRequest
object
2 required
CampaignComponentVariableResponseAsDelay
object
CampaignComponentClientKeyFlowVariableRequest
object
2 required
CampaignComponentVariableRequestAsUrl
object
ComponentSettingVariableValuesAsExtoleClientKey
object
CampaignComponentSettingRequest
2 required
CampaignComponentVariableRequestAsColor
object
DescriptionInCampaignComponentVariableRequestAsFont
Choose between static or dynamic description
SettingFilterResponseBase
object
1 property
CampaignComponentVariableRequestAsClientDomainIdList
object
DescriptionInCampaignComponentEnumVariableRequest
Choose between static or dynamic description
ComponentFacetUpdateRequest
object
Body of a PUT /v1/component-facets/{name} request.
2 properties
ComponentSettingVariableValuesAsClientKey
object
DescriptionInCampaignComponentVariableRequestAsString
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsInteger
object
ComponentDuplicateRequest
object
14 properties
ComponentFacetResponse
object
Component facet definition that describes a campaign component category and its allowed values.
5 properties
5 required
ComponentDiffResponse
object
3 properties
3 required
CampaignComponentVariableResponseAsCss
object
ValuesInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic values
ComponentSettingVariableValuesAsPersonKeyName
object
CampaignComponentVariableResponseAsJson
object
DescriptionInCampaignComponentVariableRequestAsStringList
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsFont
Choose between static or dynamic values
ValuesInCampaignComponentVariableRequestAsClientDomainIdList
Choose between static or dynamic values
ComponentSettingVariableValuesAsBoolean
object
CampaignComponentVariableRequestAsGlobComponentPath
object
CampaignComponentVariableRequestAsInteger
object
CampaignComponentVariableResponseAsWebhookId
object
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Extole publishes across the network.