Skip to main content
POST
Add component to setting

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required
setting_name
string
required

Body

application/json
source_component_id
string
required
component_display_name

Choose between static or dynamic component display name

settings
(ADMIN_ICON · object | AUDIENCE_ID · object | AUDIENCE_ID_LIST · object | BOOLEAN · object | BROWSER_SIDE_JAVASCRIPT · object | CLIENT_DOMAIN_ID_LIST · object | CLIENT_KEY · object | CLIENT_KEY_FLOW · object | COLOR · object | COMPONENT_ID · object | COMPONENT_SETTING_LOOKUP · object | CSS · object | DELAY · object | DELAY_LIST · object | ENUM · object | ENUM_LIST · object | EXTOLE_CLIENT_KEY · object | FONT · object | GLOB_COMPONENT_PATH · object | HTML · object | IMAGE · object | INTEGER · object | INTEGER_LIST · object | JSON · object | MULTI_SOCKET · object | PARTNER_ENUM · object | PARTNER_ENUM_LIST · object | PERSON_KEY_NAME · object | REWARD_SUPPLIER_ID · object | REWARD_SUPPLIER_ID_LIST · object | SOCKET · object | STRING · object | STRING_LIST · object | STRING_MAP · object | URL · object | WEBHOOK_ID · object)[]

Response

Successful response

Stored campaign component definition. Field display_name is unevaluated and appears in buildtime-evaluatable form.

assets
object[]
required
component_ids
string[]
required
component_references
object[]
required
created_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

description
string
required
display_name
required

The display name as configured: a literal value, or an expression (type:string) when defined dynamically.

facets
object[]
required
id
string
required
read-only
install
required

The install as configured: a literal value, or an expression (type:string) when defined dynamically.

installed_into_socket
string
required
name
string
required
origin
object
required
tags
string[]
required
type
string
required
types
string[]
required
updated_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

upload_version
string
required
variables
(ADMIN_ICON · object | AUDIENCE_ID · object | AUDIENCE_ID_LIST · object | BOOLEAN · object | BROWSER_SIDE_JAVASCRIPT · object | CLIENT_DOMAIN_ID_LIST · object | CLIENT_KEY · object | CLIENT_KEY_FLOW · object | COLOR · object | COMPONENT_ID · object | COMPONENT_SETTING_LOOKUP · object | CSS · object | DELAY · object | DELAY_LIST · object | ENUM · object | ENUM_LIST · object | EXTOLE_CLIENT_KEY · object | FONT · object | GLOB_COMPONENT_PATH · object | HTML · object | IMAGE · object | INTEGER · object | INTEGER_LIST · object | JSON · object | MULTI_SOCKET · object | PARTNER_ENUM · object | PARTNER_ENUM_LIST · object | PERSON_KEY_NAME · object | REWARD_SUPPLIER_ID · object | REWARD_SUPPLIER_ID_LIST · object | SOCKET · object | STRING · object | STRING_LIST · object | STRING_MAP · object | URL · object | WEBHOOK_ID · object)[]
required
version
integer<int32>
required