Skip to main content
PUT
Connect a component to an origin

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required

Body

application/json
component_id
string
required

Id of the origin component to connect to, usually the component this one was copied from. The component connects to the origin's current version.

Response

Successful response

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

assets
object[]
required
campaign_id
string
required
campaign_state
string
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. Buildtime expressions use CampaignBuildtimeContext.

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. Installtime expressions use ComponentInstalltimeContext.

installed_into_socket
string
required
name
string
required
origin
object
required

The component this one was copied from, at the version it had at the copy. A duplicate sets it. A copy of a copy in the same client keeps the first copy's origin. A change to the component's types, its install, its first-level elements other than child components, or the account-level elements it uses clears it. The component upgrade does not clear it. A component with no origin is offered no upgrade.

owner
enum<string>
required
Available options:
CLIENT,
EXTOLE,
EXTOLE_BETA
source_client_id
string
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 · object | CLIENT_DOMAIN_ID_LIST · object | CLIENT_KEY · object | CLIENT_KEY_FLOW · object | COLOR · object | COMPONENT_ID · object | COMPONENT_REFERENCE · object | COMPONENT_REFERENCE_LIST · object | COMPONENT_SETTING_LOOKUP · object | CSS · object | DATE_TIME · 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 | SFTP_DIRECTORY · object | SOCKET · object | STRING · object | STRING_LIST · object | STRING_MAP · object | TRIGGER_CONFIGURATION · object | URL · object | WEBHOOK_ID · object)[]
required
version
integer<int32>
required