Extole Components Subscriptions API
The Components Subscriptions API from Extole — 4 operation(s) for components subscriptions.
OpenAPI Specification
openapi: 3.0.1
info:
description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.'
title: Integration API - Consumer to Extole Audiences Components Subscriptions API
version: '1.0'
servers:
- description: Production
url: https://{brand}.extole.io
variables:
brand:
default: yourcompany
description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io)
security:
- HEADER: []
- QUERY: []
- COOKIE: []
tags:
- name: Components Subscriptions
paths:
/v1/component-subscriptions:
get:
description: Returns all component subscriptions for the current client.
operationId: listComponentSubscriptions
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComponentSubscriptionResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List component subscriptions
tags:
- Components Subscriptions
x-extole-bundle: management-expert
x-extole-visibility: expert
post:
description: Subscribes a client to receive updates from the specified shared component.
operationId: subscribeComponent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentSubscriptionResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_component_absolute_name_missing:
$ref: '#/components/examples/campaign_component_absolute_name_missing'
campaign_component_description_out_of_range:
$ref: '#/components/examples/campaign_component_description_out_of_range'
campaign_component_display_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_display_name_contains_illegal_character'
campaign_component_display_name_out_of_range:
$ref: '#/components/examples/campaign_component_display_name_out_of_range'
campaign_component_id_missing:
$ref: '#/components/examples/campaign_component_id_missing'
campaign_component_name_already_in_use:
$ref: '#/components/examples/campaign_component_name_already_in_use'
campaign_component_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_name_contains_illegal_character'
campaign_component_name_out_of_range:
$ref: '#/components/examples/campaign_component_name_out_of_range'
campaign_component_type_validation_failed:
$ref: '#/components/examples/campaign_component_type_validation_failed'
circular_component_reference:
$ref: '#/components/examples/circular_component_reference'
component_facets_not_found:
$ref: '#/components/examples/component_facets_not_found'
excessive_component_reference:
$ref: '#/components/examples/excessive_component_reference'
external_element_is_referenced_by_active_configuration:
$ref: '#/components/examples/external_element_is_referenced_by_active_configuration'
external_elements_cannot_have_multiple_references:
$ref: '#/components/examples/external_elements_cannot_have_multiple_references'
invalid_component_installed_into_socket:
$ref: '#/components/examples/invalid_component_installed_into_socket'
invalid_component_path:
$ref: '#/components/examples/invalid_component_path'
invalid_component_reference:
$ref: '#/components/examples/invalid_component_reference'
invalid_component_reference_socket_name:
$ref: '#/components/examples/invalid_component_reference_socket_name'
invalid_external_component_reference:
$ref: '#/components/examples/invalid_external_component_reference'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_client_id:
$ref: '#/components/examples/missing_client_id'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
missing_required_grant:
$ref: '#/components/examples/missing_required_grant'
orphan_external_component_reference:
$ref: '#/components/examples/orphan_external_component_reference'
redundant_component_reference:
$ref: '#/components/examples/redundant_component_reference'
self_component_reference:
$ref: '#/components/examples/self_component_reference'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Subscribe to a component
tags:
- Components Subscriptions
x-extole-bundle: management-expert
x-extole-visibility: expert
/v1/component-subscriptions/built:
get:
description: Returns all component subscriptions in their built (evaluated) form.
operationId: listBuiltComponentSubscriptions
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BuiltComponentSubscriptionResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List built component subscriptions
tags:
- Components Subscriptions
x-extole-bundle: management-expert
x-extole-visibility: expert
/v1/component-subscriptions/subscribers:
get:
description: Returns the clients subscribed to the specified shared component.
operationId: listSubscribers
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComponentSubscriberResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List component subscribers
tags:
- Components Subscriptions
x-extole-bundle: management-expert
x-extole-visibility: expert
/v1/component-subscriptions/{subscriptionId}:
delete:
description: Removes a client's subscription to the specified shared component.
operationId: unsubscribeComponent
parameters:
- in: path
name: subscriptionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentSubscriptionResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
campaign_component_absolute_name_missing:
$ref: '#/components/examples/campaign_component_absolute_name_missing'
campaign_component_description_out_of_range:
$ref: '#/components/examples/campaign_component_description_out_of_range'
campaign_component_display_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_display_name_contains_illegal_character'
campaign_component_display_name_out_of_range:
$ref: '#/components/examples/campaign_component_display_name_out_of_range'
campaign_component_id_missing:
$ref: '#/components/examples/campaign_component_id_missing'
campaign_component_name_already_in_use:
$ref: '#/components/examples/campaign_component_name_already_in_use'
campaign_component_name_contains_illegal_character:
$ref: '#/components/examples/campaign_component_name_contains_illegal_character'
campaign_component_name_out_of_range:
$ref: '#/components/examples/campaign_component_name_out_of_range'
campaign_component_type_validation_failed:
$ref: '#/components/examples/campaign_component_type_validation_failed'
circular_component_reference:
$ref: '#/components/examples/circular_component_reference'
component_facets_not_found:
$ref: '#/components/examples/component_facets_not_found'
excessive_component_reference:
$ref: '#/components/examples/excessive_component_reference'
external_element_is_referenced_by_active_configuration:
$ref: '#/components/examples/external_element_is_referenced_by_active_configuration'
external_elements_cannot_have_multiple_references:
$ref: '#/components/examples/external_elements_cannot_have_multiple_references'
invalid_component_installed_into_socket:
$ref: '#/components/examples/invalid_component_installed_into_socket'
invalid_component_path:
$ref: '#/components/examples/invalid_component_path'
invalid_component_reference:
$ref: '#/components/examples/invalid_component_reference'
invalid_component_reference_socket_name:
$ref: '#/components/examples/invalid_component_reference_socket_name'
invalid_external_component_reference:
$ref: '#/components/examples/invalid_external_component_reference'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_client_id:
$ref: '#/components/examples/missing_client_id'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
missing_required_grant:
$ref: '#/components/examples/missing_required_grant'
orphan_external_component_reference:
$ref: '#/components/examples/orphan_external_component_reference'
redundant_component_reference:
$ref: '#/components/examples/redundant_component_reference'
self_component_reference:
$ref: '#/components/examples/self_component_reference'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Unsubscribe from a component
tags:
- Components Subscriptions
x-extole-bundle: management-expert
x-extole-visibility: expert
components:
examples:
invalid_json:
summary: invalid_json
value:
code: invalid_json
http_status_code: 400
message: JSON is invalid
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
self_component_reference:
summary: self_component_reference
value:
code: self_component_reference
http_status_code: 400
message: Self campaign component reference is not allowed
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_id_missing:
summary: campaign_component_id_missing
value:
code: campaign_component_id_missing
http_status_code: 400
message: Campaign component id is missing
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
external_elements_cannot_have_multiple_references:
summary: external_elements_cannot_have_multiple_references
value:
code: external_elements_cannot_have_multiple_references
http_status_code: 400
message: External elements cannot have multiple references
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_component_reference_socket_name:
summary: invalid_component_reference_socket_name
value:
code: invalid_component_reference_socket_name
http_status_code: 400
message: Invalid component reference socket name
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
orphan_external_component_reference:
summary: orphan_external_component_reference
value:
code: orphan_external_component_reference
http_status_code: 400
message: Orphan external referenced campaign component
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
missing_access_token:
summary: missing_access_token
value:
code: missing_access_token
http_status_code: 403
message: No access_token was provided with this request.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
payment_required:
summary: payment_required
value:
code: payment_required
http_status_code: 402
message: The access_token provided is associated with an unpaid account.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_display_name_contains_illegal_character:
summary: campaign_component_display_name_contains_illegal_character
value:
code: campaign_component_display_name_contains_illegal_character
http_status_code: 400
message: Campaign component display name can only contain alphanumeric, dash, underscore, whitespace, asterisk, hash, dollar characters
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
unsupported_media_type:
summary: unsupported_media_type
value:
code: unsupported_media_type
http_status_code: 415
message: Request had an unsupported or no media type
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
method_unauthorized:
summary: method_unauthorized
value:
code: method_unauthorized
http_status_code: 401
message: Unauthorized access to this endpoint
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_external_component_reference:
summary: invalid_external_component_reference
value:
code: invalid_external_component_reference
http_status_code: 400
message: Unknown external referenced campaign component
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
excessive_component_reference:
summary: excessive_component_reference
value:
code: excessive_component_reference
http_status_code: 400
message: Root campaign component may have at most one reference
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_name_already_in_use:
summary: campaign_component_name_already_in_use
value:
code: campaign_component_name_already_in_use
http_status_code: 400
message: Campaign component name is already used by another component
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
missing_required_grant:
summary: missing_required_grant
value:
code: missing_required_grant
http_status_code: 400
message: Components subscription requires a valid grant from counterpart client
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_component_path:
summary: invalid_component_path
value:
code: invalid_component_path
http_status_code: 400
message: Invalid component path format. Must be in format 'campaignName:/component/path'
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_component_installed_into_socket:
summary: invalid_component_installed_into_socket
value:
code: invalid_component_installed_into_socket
http_status_code: 400
message: Invalid component installed into socket
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_name_out_of_range:
summary: campaign_component_name_out_of_range
value:
code: campaign_component_name_out_of_range
http_status_code: 400
message: Campaign component name length is out of range
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_component_reference:
summary: invalid_component_reference
value:
code: invalid_component_reference
http_status_code: 400
message: Unknown referenced campaign component
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
missing_client_id:
summary: missing_client_id
value:
code: missing_client_id
http_status_code: 400
message: Client id is missing in the request
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_type_validation_failed:
summary: campaign_component_type_validation_failed
value:
code: campaign_component_type_validation_failed
http_status_code: 400
message: Campaign component type validation failed
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_description_out_of_range:
summary: campaign_component_description_out_of_range
value:
code: campaign_component_description_out_of_range
http_status_code: 400
message: Campaign component description length is out of range
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
redundant_component_reference:
summary: redundant_component_reference
value:
code: redundant_component_reference
http_status_code: 400
message: Same reference defined multiple times
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
missing_request_body:
summary: missing_request_body
value:
code: missing_request_body
http_status_code: 400
message: Missing request body
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_name_contains_illegal_character:
summary: campaign_component_name_contains_illegal_character
value:
code: campaign_component_name_contains_illegal_character
http_status_code: 400
message: Campaign component name can only contain alphanumeric, dash and underscore characters
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
circular_component_reference:
summary: circular_component_reference
value:
code: circular_component_reference
http_status_code: 400
message: Circular campaign component reference is not allowed
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
binding_error:
summary: binding_error
value:
code: binding_error
http_status_code: 400
message: Argument is not of the expected type
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
access_denied:
summary: access_denied
value:
code: access_denied
http_status_code: 403
message: The access_token provided is not permitted to access the specified resource.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
component_facets_not_found:
summary: component_facets_not_found
value:
code: component_facets_not_found
http_status_code: 400
message: Component facets not found
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
external_element_is_referenced_by_active_configuration:
summary: external_element_is_referenced_by_active_configuration
value:
code: external_element_is_referenced_by_active_configuration
http_status_code: 400
message: External element is referenced by active configuration
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
too_many_requests:
summary: too_many_requests
value:
code: too_many_requests
http_status_code: 429
message: The server is unable to process your request at the moment, please retry later.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_parameter:
summary: invalid_parameter
value:
code: invalid_parameter
http_status_code: 400
message: Parameter is invalid.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
campaign_component_absolute_name_missing:
summary: campaign_component_absolute_name_missing
value:
code: campaign_component_absolute_name_missing
http_status_code: 400
message: Campaign component absolute name is missing
parameters: {}
unique_id: 00000000-0000-0000-00
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extole/refs/heads/main/openapi/extole-components-subscriptions-api-openapi.yml