Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Extole

Extole Components API

The Components API from Extole — 21 operation(s) for components.

Documentation Provider Profile APIs.io OpenAPI GitHub

Extole Components API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Components. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 29 operations across 21 paths, and defines 272 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.

29 operations 21 paths 272 schemas 3 DELETE18 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Components 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 29

Across 21 paths, the API surfaces 29 operations — 3 DELETE, 18 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Components 29
GET
/v1/component-facets
List component categories
listComponentFacets 3 params → 200400401402403415429
POST
/v1/component-facets
Create a component category
createComponentFacet body → 200400401402403415429
GET
/v1/component-facets/default
List default component categories
listDefaultComponentFacets → 200400401402403415429
GET
/v1/component-facets/{name}
Get a component category
getComponentFacet 1 param → 200400401402403415429
PUT
/v1/component-facets/{name}
Update a component category
updateComponentFacet 1 param body → 200400401402403415429
DELETE
/v1/component-facets/{name}
Archive a component category
archiveComponentFacet 1 param → 200400401402403415429
GET
/v1/components
List components
listComponents 22 params → 200400401402403415429
POST
/v1/components
Upload a component bundle
uploadComponentBundle body → 200400401402403415429503
GET
/v1/components/built
List built components
listBuiltComponents 22 params → 200400401402403415429
GET
/v1/components/{component_id}/available-upgrades
Get available component upgrades
getAvailableComponentUpgrades 1 param → 200400401402403415429
GET
/v1/components/{component_id}/diff/{other_component_id}
Diff two components
diffComponents 2 params → 200400401402403415429
GET
/v1/components/{component_id}/translatable.{format}
Download translatable component variables
downloadTranslatableComponentVariables 11 params → 200400401402403415429
GET
/v1/components/duplicatable
List duplicatable components
listDuplicatableComponents 20 params → 200400401402403415429
GET
/v1/components/duplicatable/built
List built duplicatable components
listBuiltDuplicatableComponents 20 params → 200400401402403415429
GET
/v1/components/{component_id}/assets
List component assets
listComponentAssets 1 param → 200400401402403415429
POST
/v1/components/{component_id}/assets
Create a component asset
createComponentAsset 1 param body → 200400401402403415429
GET
/v1/components/{component_id}/assets/built
List built component assets
listBuilt 1 param → 200400401402403415429
GET
/v1/components/{component_id}/assets/{asset_id}
Get a component asset
getComponentAsset 2 params → 200400401402403415429
PUT
/v1/components/{component_id}/assets/{asset_id}
Update a component asset
updateComponentAsset 2 params body → 200400401402403415429
DELETE
/v1/components/{component_id}/assets/{asset_id}
Delete a component asset
deleteComponentAsset 2 params → 200400401402403415429
GET
/v1/components/{component_id}/assets/{asset_id}/built
Get a built component asset
getBuilt 2 params → 200400401402403415429
GET
/v1/components/{component_id}/assets/{asset_id}/content
Get component asset content
getContent 2 params → 200400401402403415429
GET
/v1/components/{component_id}{version}
Get a component
getComponent 2 params → 200400401402403415429
DELETE
/v1/components/{component_id}{version}
Delete a component
deleteComponent 2 params → 200400401402403415429
GET
/v1/components/{component_id}{version}/built
Get a built component
getBuiltComponent 2 params → 200400401402403415429
GET
/v1/components/{component_id}{version}/anchors
Get component anchors
getComponentAnchors 2 params → 200400401402403415429
POST
/v1/components/{component_id}/upgrade
Upgrade a component
upgradeComponent 1 param → 200400401402403415429
POST
/v1/components/{component_id}{version}/duplicate
Duplicate a component
duplicateComponent 2 params body → 200400401402403415429
PUT
/v1/components/translatable
Upload translatable component variables
uploadTranslatableComponentVariables 2 params body → 200400401402403415429

Schemas 272

The contract defines 272 schemas that model the data the API accepts and returns. The most detailed are BuiltComponentResponse (24 properties), ComponentResponse (23 properties), ComponentDuplicateRequest (14 properties), BuiltCampaignComponentVariableResponse (10 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-components-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
AE Profile APIs.io
Extole Authentication API
AE Profile APIs.io
Extole Batch Jobs API
AE Profile APIs.io
Extole Blocks API
AE Profile APIs.io
Extole Campaign Controllers Actions API
AE Profile APIs.io
Extole Campaign Controllers API
AE Profile APIs.io
Extole Campaign Controllers Triggers API
AE Profile APIs.io
Extole Campaign Flow Steps API
AE Profile APIs.io
Extole Campaigns API
AE Profile APIs.io
Extole Components Grants API
AE Profile APIs.io
Extole Components Settings API
AE Profile APIs.io
Extole Components Subscriptions API
AE Profile APIs.io
#Components
← Back to E APIs
API Details
ID
extole:extole-components-api
Base URL
https://api.extole.io
Docs
https://developers.extole.com/
Provider
Extole
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network