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 Settings API

The Components Settings API from Extole — 7 operation(s) for components settings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Extole Components Settings 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 Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 7 paths, and defines 336 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.

11 operations 7 paths 336 schemas 1 DELETE5 GET3 POST2 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 Settings 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 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Components Settings 11
GET
/v1/components/{component_id}/settings
List component settings
listComponentSettings 1 param → 200400401402403415429
POST
/v1/components/{component_id}/settings
Create a component setting
createComponentSetting 1 param body → 200400401402403415429
PUT
/v1/components/{component_id}/settings
Batch update component settings
batchUpdateComponentSettings 1 param body → 200400401402403415429
GET
/v1/components/{component_id}/settings/built
List built component settings
listBuiltComponentSettings 1 param → 200400401402403415429
GET
/v1/components/{component_id}/settings/{setting_name}
Get a component setting
getComponentSetting 2 params → 200400401402403415429
PUT
/v1/components/{component_id}/settings/{setting_name}
Update a component setting
updateComponentSetting 2 params body → 200400401402403415429
DELETE
/v1/components/{component_id}/settings/{setting_name}
Delete a component setting
deleteComponentSetting 2 params → 200400401402403415429
GET
/v1/components/{component_id}/settings/{setting_name}/built
Get a built component setting
getBuiltComponentSetting 2 params → 200400401402403415429
GET
/v1/components/{component_id}/settings/{setting_name}/installed-components
List installed components in setting
listInstalledComponentsInSetting 2 params → 200400401402403415429
POST
/v1/components/{component_id}/settings/{setting_name}/add-component
Add component to setting
addComponentToSetting 2 params body → 200400401402403415429
POST
/v1/components/{component_id}/settings/{setting_name}/remove-component/{target_component_id}
Remove component from setting
removeComponentFromSetting 3 params → 200400401402403415429

Schemas 336

The contract defines 336 schemas that model the data the API accepts and returns. The most detailed are CampaignComponentResponse (19 properties), BuiltCampaignComponentVariableResponse (10 properties), CampaignComponentVariableResponse (8 properties), CampaignComponentVariableRequest (8 properties). Each schema is shown below with its type and property counts.

SettingFilterUpdateRequestBase
object
1 property
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
CampaignComponentVariableRequestAsJson
object
DescriptionInCampaignComponentVariableUpdateRequestAsBoolean
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsWebhookId
Choose between static or dynamic description
CampaignComponentFacetResponse
object
2 properties
CampaignComponentResponse
object
Stored campaign component definition. Field displayname is unevaluated and appears in buildtime-evaluatable form.
19 properties 19 required
CampaignComponentSettingUpdateRequestBase
object
5 properties
ComponentSettingBatchUpdateRequest
object
Body of a PUT /v1/components/{componentid}/settings request.
1 property 1 required
WebhookIdInCampaignComponentPartnerEnumListVariableUpdateRequest
Choose between static or dynamic webhook id
DescriptionInCampaignComponentRewardSupplierIdListVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsDelayList
object
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
ComponentSettingVariableValuesAsWebhookId
object
CampaignComponentPartnerEnumVariableResponse
object
Stored campaign component partner enum variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
ComponentSettingVariableValuesAsDelayList
object
ComponentSettingVariableValuesAsUrl
object
CampaignComponentSocketUpdateRequestAsSocket
object
1 required
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
DescriptionInCampaignComponentStringMapVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableRequestAsGlobComponentPath
object
CampaignComponentVariableResponse
object
8 properties
CampaignComponentVariableRequestAsClientKey
object
DescriptionInCampaignComponentVariableUpdateRequestAsExtoleClientKey
Choose between static or dynamic description
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
DescriptionInCampaignComponentPartnerEnumListVariableUpdateRequest
Choose between static or dynamic description
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
DescriptionInCampaignComponentVariableUpdateRequestAsFont
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsUrl
object
DescriptionInCampaignComponentVariableRequestAsInteger
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsClientDomainIdList
Choose between static or dynamic description
CampaignComponentVariableResponseAsGlobComponentPath
object
ComponentIdFilterUpdateRequest
object
1 property
DescriptionInCampaignComponentEnumVariableRequest
Choose between static or dynamic description
ComponentTypeSettingFilterUpdateRequest
object
1 required
ValuesInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic values
CampaignComponentVariableUpdateRequestAsClientDomainIdList
object
DescriptionInCampaignComponentClientKeyFlowVariableRequest
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsIntegerList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsBoolean
Choose between static or dynamic description
ComponentReferenceResponse
object
2 properties
DescriptionInCampaignComponentVariableUpdateRequestAsAudienceIdList
Choose between static or dynamic description
CampaignComponentEnumListVariableUpdateRequest
object
1 required
ValuesInCampaignComponentVariableRequestAsString
Choose between static or dynamic values
ComponentSettingVariableValuesAsFont
object
CampaignComponentPartnerEnumListVariableUpdateRequest
object
1 required
InstallInCampaignComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignComponentVariableUpdateRequestAsCss
Choose between static or dynamic description
CampaignComponentStringMapVariableResponse
object
Stored campaign component string map variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
CampaignComponentSettingUpdateRequest
Body of a PUT /v2/campaigns/{campaignid}{version:(/version/.+)?}/components/{componentid}/variables/{settingname} request.
1 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
CampaignComponentVariableUpdateRequestAsPersonKeyName
object
CampaignComponentVariableRequestAsIntegerList
object
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableUpdateRequest
Choose between static or dynamic captured setting values description
BuiltCampaignComponentVariableResponseAsDelayList
object
DescriptionInCampaignComponentPartnerEnumListVariableRequest
Choose between static or dynamic description
ComponentSettingVariableValuesAsJson
object
CampaignComponentVariableUpdateRequestAsHtml
object
ComponentIdFilterCreateRequest
object
1 property
SettingFilterUpdateRequest
BuiltCampaignComponentVariableResponseAsIntegerList
object
DescriptionInCampaignComponentVariableRequestAsStringList
Choose between static or dynamic description
ComponentSettingVariableValuesAsString
object
CampaignComponentVariableUpdateRequestAsStringList
object
CampaignComponentVariableUpdateRequestAsRewardSupplierId
object
DescriptionInCampaignComponentVariableUpdateRequestAsString
Choose between static or dynamic description
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
DescriptionInCampaignComponentSocketUpdateRequestAsMultiSocket
Choose between static or dynamic description
CampaignComponentVariableResponseAsWebhookId
object
DescriptionInCampaignComponentVariableUpdateRequestAsDelay
Choose between static or dynamic description
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
DescriptionInCampaignComponentVariableUpdateRequestAsAudienceId
Choose between static or dynamic description
CampaignComponentClientKeyFlowVariableRequest
object
2 required
DescriptionInCampaignComponentEnumListVariableUpdateRequest
Choose between static or dynamic description
DescriptionInCampaignComponentComponentIdVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableResponseAsAudienceIdList
object
CampaignComponentVariableUpdateRequestAsImage
object
CampaignComponentVariableUpdateRequestAsCss
object
CampaignComponentVariableUpdateRequestAsAdminIcon
object
CampaignComponentVariableResponseAsExtoleClientKey
object
ComponentTypeSettingFilterCreateRequest
object
2 required
CampaignComponentVariableResponseAsBoolean
object
ExpressionInExpressionSettingFilterCreateRequest
Choose between static or dynamic expression
DescriptionInCampaignComponentVariableRequestAsCss
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsIntegerList
object
ComponentSettingVariableValuesAsIntegerList
object
BuiltCampaignComponentVariableResponseAsBrowserSideJavascript
object
ComponentSettingVariableValuesAsClientKey
object
DescriptionInCampaignComponentVariableUpdateRequestAsHtml
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic values
WebhookIdInCampaignComponentPartnerEnumListVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignComponentVariableUpdateRequestAsAdminIcon
Choose between static or dynamic description
CampaignComponentVariableRequestAsStringList
object
ComponentSettingVariableValuesAsExtoleClientKey
object
DescriptionInCampaignComponentVariableUpdateRequestAsJson
Choose between static or dynamic description
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
ComponentDisplayNameInCampaignComponentSocketAddComponentRequest
Choose between static or dynamic component display name
DescriptionInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsInteger
object
ValuesInCampaignComponentVariableRequestAsFont
Choose between static or dynamic values
CampaignComponentVariableResponseAsDelay
object
CampaignComponentVariableUpdateRequestAsString
object
ValuesInCampaignComponentVariableRequestAsExtoleClientKey
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsGlobComponentPath
Choose between static or dynamic description
BuiltComponentSocketResponseAsSocket
object
9 required
WebhookIdInCampaignComponentPartnerEnumVariableUpdateRequest
Choose between static or dynamic webhook id
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
CampaignComponentComponentSettingLookupVariableUpdateRequest
object
1 required
CampaignComponentVariableResponseAsInteger
object
ValuesInCampaignComponentVariableRequestAsDelayList
Choose between static or dynamic values
ComponentAssetResponse
object
5 properties
CampaignComponentVariableUpdateRequestAsColor
object
DescriptionInCampaignComponentVariableRequestAsAudienceIdList
Choose between static or dynamic description
ComponentSettingVariableValuesAsStringList
object
BuiltComponentComponentSettingLookupVariableResponse
object
14 required
DescriptionInCampaignComponentVariableRequestAsAdminIcon
Choose between static or dynamic description
CampaignComponentVariableResponseAsImage
object
BuiltCampaignComponentVariableResponseAsClientKey
object
CampaignComponentRewardSupplierIdListVariableUpdateRequest
object
1 required
DescriptionInCampaignComponentVariableUpdateRequestAsPersonKeyName
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsImage
Choose between static or dynamic description
SettingFilterResponseBase
object
1 property
DescriptionInCampaignComponentVariableRequestAsClientDomainIdList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsString
Choose between static or dynamic description
DescriptionInCampaignComponentClientKeyFlowVariableUpdateRequest
Choose between static or dynamic description
DescriptionInCampaignComponentSocketRequestAsMultiSocket
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic description
CampaignComponentPartnerEnumVariableUpdateRequest
object
1 required
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
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.
CampaignComponentVariableUpdateRequestAsWebhookId
object
DescriptionInCampaignComponentVariableRequestAsPersonKeyName
Choose between static or dynamic description
CampaignComponentVariableRequestAsExtoleClientKey
object
CampaignComponentVariableRequestAsUrl
object
DescriptionInCampaignComponentVariableUpdateRequestAsDelayList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsColor
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsPersonKeyName
Choose between static or dynamic values
ComponentFacetSettingFilterResponse
object
3 required
ComponentSettingVariableValuesAsCss
object
CampaignComponentVariableUpdateRequestAsBoolean
object
BuiltCampaignComponentSettingResponseBase
object
6 properties
DescriptionInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic description
CampaignComponentComponentIdVariableUpdateRequest
object
1 required
CampaignComponentSocketResponseAsMultiSocket
object
Stored campaign component socket definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableUpdateRequest
Choose between static or dynamic allowed reward supplier ids
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.
DescriptionInCampaignComponentPartnerEnumVariableUpdateRequest
Choose between static or dynamic description
BuiltComponentStringMapVariableResponse
object
11 required
ValuesInCampaignComponentVariableRequestAsHtml
Choose between static or dynamic values
DescriptionInCampaignComponentComponentSettingLookupVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsClientKey
object
BuiltCampaignComponentVariableResponseAsRewardSupplierId
object
ValuesInCampaignComponentVariableRequestAsJson
Choose between static or dynamic values
BuiltComponentComponentIdVariableResponse
object
11 required
DescriptionInCampaignComponentVariableUpdateRequestAsRewardSupplierId
Choose between static or dynamic description
DescriptionInCampaignComponentSocketUpdateRequestAsSocket
Choose between static or dynamic description
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
CampaignComponentVariableUpdateRequestAsUrl
object
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
ExpressionInExpressionSettingFilterUpdateRequest
Choose between static or dynamic expression
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
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
DescriptionInCampaignComponentVariableUpdateRequestAsColor
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsStringList
Choose between static or dynamic description
EnInBuiltComponentSettingValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
CampaignComponentVariableResponseAsRewardSupplierId
object
BuiltCampaignComponentVariableResponseAsWebhookId
object
CampaignComponentSettingResponse
6 required
CampaignComponentPartnerEnumListVariableResponse
object
Stored campaign component partner enum list variable definition. Fields description and webhookid are unevaluated and appear in buildtime-evaluatable form.
10 required
ComponentTypeSettingFilterResponse
object
2 required
ValuesInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic values
ComponentSettingVariableValuesAsInteger
object
BuiltCampaignComponentVariableResponseAsBoolean
object
CampaignComponentVariableRequestAsString
object
CampaignComponentEnumVariableUpdateRequest
object
1 required
ComponentSettingVariableValuesAsColor
object
DescriptionInCampaignComponentComponentSettingLookupVariableRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsDelay
object
CampaignComponentVariableUpdateRequestAsFont
object
CampaignComponentVariableResponseAsBrowserSideJavascript
object
DescriptionInCampaignComponentVariableUpdateRequestAsUrl
Choose between static or dynamic description
DescriptionInCampaignComponentVariableResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
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
DescriptionInCampaignComponentVariableUpdateRequestAsClientKey
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsClientDomainIdList
object
DescriptionInCampaignComponentVariableRequestAsClientKey
Choose between static or dynamic description
CampaignComponentVariableRequestAsAudienceIdList
object
CampaignComponentVariableUpdateRequestAsJson
object
DisplayNameInCampaignComponentResponse
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentSettingVariableValuesAsBoolean
object
CampaignComponentSocketUpdateRequestAsMultiSocket
object
1 required
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
CampaignComponentSocketAddComponentRequest
object
3 properties 1 required
DescriptionInCampaignComponentVariableUpdateRequestAsBrowserSideJavascript
Choose between static or dynamic description
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
DescriptionInCampaignComponentEnumVariableUpdateRequest
Choose between static or dynamic description
ComponentSettingVariableValuesAsDelay
object
CampaignComponentVariableUpdateRequestAsExtoleClientKey
object
CampaignComponentVariableUpdateRequestAsBrowserSideJavascript
object
CampaignComponentVariableResponseAsPersonKeyName
object
CampaignComponentVariableRequestAsBrowserSideJavascript
object
CampaignComponentStringMapVariableUpdateRequest
object
1 required
CampaignComponentVariableRequest
object
8 properties
BuiltCampaignComponentVariableResponseAsGlobComponentPath
object
CampaignComponentVariableUpdateRequestAsAudienceIdList
object
CampaignComponentVariableRequestAsDelay
object
ExpressionSettingFilterUpdateRequest
object
2 required
BuiltCampaignComponentVariableResponseAsInteger
object
ValuesInCampaignComponentVariableRequestAsWebhookId
Choose between static or dynamic values
CampaignComponentVariableUpdateRequestAsAudienceId
object
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
BuiltCampaignComponentVariableResponseAsAudienceIdList
object
SettingFilterCreateRequestBase
object
1 property
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…
ComponentFacetSettingFilterCreateRequest
object
3 required
ComponentFacetSettingFilterUpdateRequest
object
1 required
CampaignComponentVariableUpdateRequestAsGlobComponentPath
object
ValuesInCampaignComponentVariableRequestAsColor
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsInteger
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsAdminIcon
object
ComponentSettingVariableValuesAsRewardSupplierId
object
BuiltCampaignComponentVariableResponseAsJson
object
CampaignComponentVariableResponseAsJson
object
CampaignComponentVariableResponseAsDelayList
object
DeweyDecimal
string
BuiltCampaignComponentSettingResponse
6 required
BuiltCampaignComponentVariableResponseAsDelay
object
BuiltComponentPartnerEnumVariableResponse
object
12 required
BuiltCampaignComponentVariableResponseAsPersonKeyName
object
CampaignComponentVariableRequestAsInteger
object
BuiltCampaignComponentVariableResponseAsHtml
object
CampaignComponentEnumListVariableRequest
object
2 required
CampaignComponentClientKeyFlowVariableUpdateRequest
object
1 required
ValuesInCampaignComponentVariableRequestAsAdminIcon
Choose between static or dynamic values
CampaignComponentVariableResponseAsUrl
object
ComponentSettingVariableValuesAsPersonKeyName
object
ComponentSettingVariableValuesAsHtml
object
WebhookIdInCampaignComponentPartnerEnumVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-components-settings-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 API
AE Profile APIs.io
Extole Components Grants API
AE Profile APIs.io
Extole Components Subscriptions API
AE Profile APIs.io
#Components Settings
← Back to E APIs
API Details
ID
extole:extole-components-settings-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