How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.2.0, 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.2.0
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), CampaignComponentVariableRequest (8 properties), CampaignComponentVariableResponse (8 properties). Each schema is shown below with its type and property counts.

AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableRequest
Choose between static or dynamic allowed reward supplier ids
DescriptionInCampaignComponentVariableRequestAsDelayList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsExtoleClientKey
Choose between static or dynamic description
ComponentSettingVariableValuesAsStringList
object
CampaignComponentClientKeyFlowVariableUpdateRequest
object
1 required
CampaignComponentVariableResponseAsHtml
object
ComponentSettingVariableValuesAsBrowserSideJavascript
object
ComponentAssetResponse
object
5 properties
DeweyDecimal
string
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
DescriptionInCampaignComponentVariableUpdateRequestAsBoolean
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsClientDomainIdList
object
DescriptionInCampaignComponentVariableUpdateRequestAsAudienceId
Choose between static or dynamic description
CampaignComponentVariableResponse
object
8 properties
WebhookIdInCampaignComponentPartnerEnumVariableResponse
The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsRewardSupplierId
object
CampaignComponentVariableUpdateRequestAsExtoleClientKey
object
ComponentSettingVariableValuesAsRewardSupplierId
object
DescriptionInCampaignComponentVariableResponse
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
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
SettingFilterUpdateRequestBase
object
1 property
ComponentSettingVariableValuesAsDelayList
object
CampaignComponentSocketRequestAsSocket
object
2 required
CampaignComponentVariableResponseAsAdminIcon
object
CampaignComponentVariableUpdateRequestAsRewardSupplierId
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
CampaignComponentSocketAddComponentRequest
object
3 properties 1 required
CampaignComponentVariableResponseAsAudienceId
object
ComponentSettingVariableValuesAsCss
object
CampaignComponentSettingResponse
6 required
CampaignComponentRewardSupplierIdListVariableUpdateRequest
object
1 required
CampaignComponentVariableResponseAsUrl
object
DescriptionInCampaignComponentPartnerEnumVariableUpdateRequest
Choose between static or dynamic description
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableRequest
Choose between static or dynamic captured setting values description
ComponentOriginResponse
object
3 properties
DescriptionInCampaignComponentRewardSupplierIdListVariableUpdateRequest
Choose between static or dynamic description
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
DescriptionInCampaignComponentVariableUpdateRequestAsBrowserSideJavascript
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsPersonKeyName
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsGlobComponentPath
Choose between static or dynamic description
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
BuiltCampaignComponentSettingResponse
6 required
CampaignComponentComponentSettingLookupVariableRequest
object
3 required
DescriptionInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic description
PartnerEnumListVariableOptionResponse
object
2 properties
CampaignComponentVariableUpdateRequestAsString
object
ValuesInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic values
ComponentSettingVariableValuesAsUrl
object
DescriptionInCampaignComponentVariableUpdateRequestAsCss
Choose between static or dynamic description
CampaignComponentFacetResponse
object
2 properties
BuiltCampaignComponentVariableResponseAsDelayList
object
ComponentTypeSettingFilterResponse
object
2 required
CampaignComponentVariableRequestAsStringList
object
BuiltCampaignComponentVariableResponseAsAudienceIdList
object
BuiltCampaignComponentVariableResponseAsBoolean
object
BuiltCampaignComponentVariableResponseAsFont
object
SettingFilterResponse
ValuesInCampaignComponentVariableRequestAsBrowserSideJavascript
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsImage
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsClientDomainIdList
object
CampaignComponentVariableRequestAsJson
object
CampaignComponentVariableUpdateRequestAsFont
object
DescriptionInCampaignComponentVariableRequestAsClientKey
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsInteger
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsStringList
object
DescriptionInCampaignComponentVariableUpdateRequestAsRewardSupplierId
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsString
Choose between static or dynamic description
CampaignComponentVariableRequestAsHtml
object
CampaignComponentVariableUpdateRequestAsAudienceId
object
BuiltComponentRewardSupplierIdListVariableResponse
object
11 required
CampaignComponentVariableResponseAsGlobComponentPath
object
BuiltCampaignComponentVariableResponseAsDelay
object
CampaignComponentVariableRequestAsClientKey
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
CapturedSettingValuesDescriptionInCampaignComponentComponentSettingLookupVariableUpdateRequest
Choose between static or dynamic captured setting values description
BuiltCampaignComponentVariableResponseAsImage
object
ValuesInCampaignComponentVariableRequestAsStringList
Choose between static or dynamic values
ComponentReferenceResponse
object
2 properties
BuiltComponentSocketResponseAsSocket
object
9 required
CampaignComponentVariableResponseAsString
object
DisplayNameInCampaignComponentResponse
The display name as configured: a literal value, or an expression (type:string) when defined dynamically.
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableResponse
The allowed reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInCampaignComponentVariableUpdateRequestAsClientKey
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsWebhookId
Choose between static or dynamic values
DescriptionInCampaignComponentVariableRequestAsColor
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsColor
object
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
ExpressionInExpressionSettingFilterUpdateRequest
Choose between static or dynamic expression
DescriptionInCampaignComponentVariableUpdateRequestAsAudienceIdList
Choose between static or dynamic description
CampaignComponentVariableResponseAsImage
object
CampaignComponentVariableUpdateRequestAsUrl
object
BuiltCampaignComponentVariableResponseAsAdminIcon
object
EnInComponentSettingVariableValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
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
DescriptionInCampaignComponentVariableRequestAsGlobComponentPath
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequest
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsClientDomainIdList
Choose between static or dynamic description
CampaignComponentStringMapVariableUpdateRequest
object
1 required
CampaignComponentVariableResponseAsClientDomainIdList
object
SettingFilterUpdateRequest
ExpressionSettingFilterUpdateRequest
object
2 required
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
DescriptionInCampaignComponentVariableUpdateRequestAsAdminIcon
Choose between static or dynamic description
ValuesInCampaignComponentVariableRequestAsDelayList
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsJson
Choose between static or dynamic description
ComponentSettingVariableValuesAsString
object
CampaignComponentVariableRequestAsImage
object
ComponentSettingVariableValuesAsIntegerList
object
CampaignComponentEnumVariableUpdateRequest
object
1 required
ValuesInCampaignComponentVariableRequestAsString
Choose between static or dynamic values
WebhookIdInCampaignComponentPartnerEnumListVariableUpdateRequest
Choose between static or dynamic webhook id
ComponentDisplayNameInCampaignComponentSocketAddComponentRequest
Choose between static or dynamic component display name
AllowedRewardSupplierIdsInCampaignComponentRewardSupplierIdListVariableUpdateRequest
Choose between static or dynamic allowed reward supplier ids
EnInBuiltComponentSettingValues
Example locale value key. Use any locale or environment code as the key; en is shown only as a representative example.
CampaignComponentPartnerEnumListVariableUpdateRequest
object
1 required
DescriptionInCampaignComponentSocketUpdateRequestAsSocket
Choose between static or dynamic description
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
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
DescriptionInCampaignComponentVariableUpdateRequestAsDelay
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsUrl
Choose between static or dynamic description
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
CampaignComponentComponentSettingLookupVariableUpdateRequest
object
1 required
DescriptionInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic description
CampaignComponentSettingResponseBase
object
6 properties
BuiltComponentStringMapVariableResponse
object
11 required
BuiltCampaignComponentVariableResponseAsString
object
ComponentSettingBatchUpdateRequest
object
Body of a PUT /v1/components/{componentid}/settings request.
1 property 1 required
CampaignComponentVariableResponseAsBoolean
object
ComponentSettingVariableValuesAsHtml
object
ComponentSettingVariableValuesAsInteger
object
BuiltCampaignComponentVariableResponseAsHtml
object
CampaignComponentVariableUpdateRequestAsClientKey
object
InstallInCampaignComponentResponse
The install as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentSettingVariableValuesAsAdminIcon
object
CampaignComponentVariableRequestAsAudienceIdList
object
BuiltCampaignComponentVariableResponseAsGlobComponentPath
object
CampaignComponentVariableRequestAsExtoleClientKey
object
CampaignComponentVariableRequestAsAdminIcon
object
BuiltCampaignComponentVariableResponseAsRewardSupplierId
object
ValuesInCampaignComponentVariableRequestAsExtoleClientKey
Choose between static or dynamic values
CampaignComponentStringMapVariableRequest
object
2 required
ComponentSettingVariableValuesAsDelay
object
CampaignComponentVariableUpdateRequestAsIntegerList
object
ValuesInCampaignComponentVariableRequestAsJson
Choose between static or dynamic values
ComponentIdFilterCreateRequest
object
1 property
DescriptionInCampaignComponentComponentSettingLookupVariableUpdateRequest
Choose between static or dynamic description
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.
CampaignComponentSettingUpdateRequestBase
object
5 properties
DescriptionInCampaignComponentVariableRequestAsImage
Choose between static or dynamic description
ComponentSettingVariableValuesAsImage
object
CampaignComponentPartnerEnumVariableRequest
object
2 required
DescriptionInCampaignComponentVariableUpdateRequestAsInteger
Choose between static or dynamic description
BuiltCampaignComponentSettingResponseBase
object
6 properties
DescriptionInCampaignComponentComponentIdVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsAdminIcon
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…
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
CampaignComponentComponentIdVariableUpdateRequest
object
1 required
ValuesInCampaignComponentVariableRequestAsHtml
Choose between static or dynamic values
DescriptionInCampaignComponentVariableRequestAsRewardSupplierId
Choose between static or dynamic description
CampaignComponentVariableResponseAsClientKey
object
CampaignComponentVariableUpdateRequestAsDelayList
object
CampaignComponentEnumVariableResponse
object
Stored campaign component enum variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
9 required
CampaignComponentVariableUpdateRequestAsHtml
object
CampaignComponentVariableUpdateRequestAsBoolean
object
ComponentSettingVariableValuesAsJson
object
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
CampaignComponentVariableUpdateRequestAsPersonKeyName
object
DescriptionInCampaignComponentSettingResponseBase
The description as configured: a literal value, or an expression (type:string) when defined dynamically.
CampaignComponentVariableResponseAsFont
object
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
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
CampaignComponentSocketUpdateRequestAsSocket
object
1 required
DescriptionInCampaignComponentVariableRequestAsAdminIcon
Choose between static or dynamic description
BuiltCampaignComponentVariableResponseAsBrowserSideJavascript
object
DescriptionInCampaignComponentVariableRequestAsWebhookId
Choose between static or dynamic description
DescriptionInCampaignComponentSocketUpdateRequestAsMultiSocket
Choose between static or dynamic description
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
CampaignComponentPartnerEnumVariableUpdateRequest
object
1 required
CampaignComponentRewardSupplierIdListVariableRequest
object
2 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
CampaignComponentVariableUpdateRequestAsWebhookId
object
CampaignComponentEnumVariableRequest
object
2 required
ValuesInCampaignComponentVariableRequestAsIntegerList
Choose between static or dynamic values
CampaignComponentVariableUpdateRequestAsCss
object
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
CampaignComponentEnumListVariableUpdateRequest
object
1 required
WebhookIdInCampaignComponentPartnerEnumVariableRequest
Choose between static or dynamic webhook id
WebhookIdInCampaignComponentPartnerEnumVariableUpdateRequest
Choose between static or dynamic webhook id
ValuesInCampaignComponentVariableRequestAsColor
Choose between static or dynamic values
ExpressionInExpressionSettingFilterCreateRequest
Choose between static or dynamic expression
CampaignComponentVariableUpdateRequestAsInteger
object
CampaignComponentVariableUpdateRequestAsImage
object
DescriptionInCampaignComponentVariableUpdateRequestAsStringList
Choose between static or dynamic description
CampaignComponentSettingRequestBase
object
5 properties
CampaignComponentVariableRequestAsCss
object
CampaignComponentVariableResponseAsStringList
object
BuiltComponentComponentIdVariableResponse
object
11 required
DescriptionInCampaignComponentVariableUpdateRequestAsColor
Choose between static or dynamic description
CampaignComponentComponentIdVariableRequest
object
2 required
ComponentSettingVariableValuesAsColor
object
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
DescriptionInCampaignComponentVariableUpdateRequestAsPersonKeyName
Choose between static or dynamic description
CampaignComponentClientKeyFlowVariableResponse
object
Stored campaign component client key flow variable definition. Field description is unevaluated and appears in buildtime-evaluatable form.
11 required
BuiltComponentPartnerEnumVariableResponse
object
12 required
ComponentSettingVariableValuesAsGlobComponentPath
object
CampaignComponentVariableUpdateRequestAsAudienceIdList
object
CampaignComponentVariableRequestAsRewardSupplierId
object
CampaignComponentVariableRequestAsAudienceId
object
CampaignComponentVariableRequestAsBrowserSideJavascript
object
ValuesInCampaignComponentVariableRequestAsUrl
Choose between static or dynamic values
BuiltCampaignComponentVariableResponseAsClientKey
object
ComponentSettingVariableValuesAsFont
object
DescriptionInCampaignComponentClientKeyFlowVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsStringList
object
BuiltCampaignComponentVariableResponseAsWebhookId
object
CampaignComponentVariableUpdateRequestAsBrowserSideJavascript
object
ComponentSettingVariableValuesAsWebhookId
object
BuiltCampaignComponentVariableResponseAsPersonKeyName
object
DescriptionInCampaignComponentVariableUpdateRequestAsFont
Choose between static or dynamic description
DescriptionInCampaignComponentSocketRequestAsMultiSocket
Choose between static or dynamic description
DescriptionInCampaignComponentStringMapVariableRequest
Choose between static or dynamic description
BuiltComponentClientKeyFlowVariableResponse
object
13 required
SettingFilterCreateRequest
ComponentSettingVariableValuesAsAudienceId
object
DescriptionInCampaignComponentVariableRequestAsCss
Choose between static or dynamic description
CampaignComponentVariableResponseAsAudienceIdList
object
BuiltCampaignComponentVariableResponseAsColor
object
DescriptionInCampaignComponentComponentSettingLookupVariableRequest
Choose between static or dynamic description
CampaignComponentVariableResponseAsPersonKeyName
object
ComponentIdFilterResponse
object
1 property
CampaignComponentVariableUpdateRequestAsJson
object
WebhookIdInCampaignComponentPartnerEnumListVariableRequest
Choose between static or dynamic webhook id
CampaignComponentPartnerEnumListVariableRequest
object
2 required
CampaignComponentVariableResponseAsDelay
object
CampaignComponentClientKeyFlowVariableRequest
object
2 required
CampaignComponentVariableRequestAsUrl
object
ComponentSettingVariableValuesAsExtoleClientKey
object
DescriptionInCampaignComponentPartnerEnumListVariableUpdateRequest
Choose between static or dynamic description
DescriptionInCampaignComponentVariableUpdateRequestAsHtml
Choose between static or dynamic description
CampaignComponentSettingRequest
2 required
CampaignComponentVariableRequestAsColor
object
ComponentTypeSettingFilterUpdateRequest
object
1 required
DescriptionInCampaignComponentVariableUpdateRequestAsDelayList
Choose between static or dynamic description
DescriptionInCampaignComponentVariableRequestAsFont
Choose between static or dynamic description
SettingFilterResponseBase
object
1 property
DescriptionInCampaignComponentStringMapVariableUpdateRequest
Choose between static or dynamic description
CampaignComponentVariableUpdateRequestAsGlobComponentPath
object
CampaignComponentVariableRequestAsClientDomainIdList
object
DescriptionInCampaignComponentEnumVariableRequest
Choose between static or dynamic description
DescriptionInCampaignComponentEnumListVariableUpdateRequest
Choose between static or dynamic description
ComponentSettingVariableValuesAsClientKey
object
DescriptionInCampaignComponentVariableRequestAsString
Choose between static or dynamic description
ComponentIdFilterUpdateRequest
object
1 property
BuiltCampaignComponentVariableResponseAsInteger
object
DescriptionInCampaignComponentEnumVariableUpdateRequest
Choose between static or dynamic description
ComponentFacetSettingFilterUpdateRequest
object
1 required
CampaignComponentVariableResponseAsCss
object
CampaignComponentResponse
object
Stored campaign component definition. Field displayname is unevaluated and appears in buildtime-evaluatable form.
19 properties 19 required
ValuesInCampaignComponentVariableRequestAsDelay
Choose between static or dynamic values
ComponentSettingVariableValuesAsPersonKeyName
object
CampaignComponentVariableResponseAsJson
object
DescriptionInCampaignComponentVariableRequestAsStringList
Choose between static or dynamic description
CampaignComponentSocketUpdateRequestAsMultiSocket
object
1 required
ValuesInCampaignComponentVariableRequestAsFont
Choose between static or dynamic values
ValuesInCampaignComponentVariableRequestAsClientDomainIdList
Choose between static or dynamic values
DescriptionInCampaignComponentVariableUpdateRequestAsIntegerList
Choose between static or dynamic description
CampaignComponentSettingUpdateRequest
Body of a PUT /v2/campaigns/{campaignid}{version:(/version/.+)?}/components/{componentid}/variables/{settingname} request.
1 required
ComponentSettingVariableValuesAsBoolean
object
DescriptionInCampaignComponentVariableUpdateRequestAsWebhookId
Choose between static or dynamic description
CampaignComponentVariableRequestAsGlobComponentPath
object
CampaignComponentVariableRequestAsInteger
object
CampaignComponentVariableResponseAsWebhookId
object
CampaignComponentVariableUpdateRequestAsDelay
object

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://docs.extole.com/
Provider
Extole
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=extole-components-settings-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/extole-components-settings-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Extole Components Settings 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.