Skip to main content
PUT
Update a component setting

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required
setting_name
string
required

Body

application/json

Body of a PUT /v2/campaigns/{campaign_id}{version:(/version/.+)?}/components/{component_id}/variables/{setting_name} request.

type
enum<string>
required
Available options:
ADMIN_ICON,
AUDIENCE_ID,
AUDIENCE_ID_LIST,
BOOLEAN,
BROWSER_SIDE_JAVASCRIPT,
CLIENT_DOMAIN_ID_LIST,
CLIENT_KEY,
COLOR,
CSS,
DATE_TIME,
DELAY,
DELAY_LIST,
EXTOLE_CLIENT_KEY,
FONT,
GLOB_COMPONENT_PATH,
HTML,
IMAGE,
INTEGER,
INTEGER_LIST,
JSON,
PERSON_KEY_NAME,
REWARD_SUPPLIER_ID,
STRING,
STRING_LIST,
URL,
WEBHOOK_ID
display_name
string | null
name
string
priority
string
Example:

"10"

tags
string[]
description

Choose between static or dynamic description. Buildtime expressions use VariableDescriptionBuildtimeContext.

source
enum<string>

Where this setting takes its value from. LOCAL uses the values stored on this component. INHERITED uses the same-named setting of the nearest ancestor component that is not itself INHERITED. PARAMETER uses the same-named parameter of the socket this component is installed into. Omit to leave it unchanged; it is applied independently of values. To reconnect a setting to its ancestor, send INHERITED without values: the values stored on this component are kept but no longer used. Changing an INHERITED setting to LOCAL without values copies the inherited value onto this component.

Available options:
INHERITED,
LOCAL,
PARAMETER
values
object

Values to store on this component, keyed by locale or default. Omit to leave them unchanged. Sending values does not change source: an INHERITED setting keeps using its ancestor's value until source is set to LOCAL.

Response

Successful response

description
required

The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

display_name
string
required
name
string
required
priority
string
required
Example:

"10"

tags
string[]
required
type
enum<string>
required
Available options:
ADMIN_ICON,
AUDIENCE_ID,
AUDIENCE_ID_LIST,
BOOLEAN,
BROWSER_SIDE_JAVASCRIPT,
CLIENT_DOMAIN_ID_LIST,
CLIENT_KEY,
COLOR,
CSS,
DATE_TIME,
DELAY,
DELAY_LIST,
EXTOLE_CLIENT_KEY,
FONT,
GLOB_COMPONENT_PATH,
HTML,
IMAGE,
INTEGER,
INTEGER_LIST,
JSON,
PERSON_KEY_NAME,
REWARD_SUPPLIER_ID,
STRING,
STRING_LIST,
URL,
WEBHOOK_ID
source
enum<string>

Where this setting takes its value from. LOCAL uses the values stored on this component. INHERITED uses the same-named setting of the nearest ancestor component that is not itself INHERITED. PARAMETER uses the same-named parameter of the socket this component is installed into. For an INHERITED setting, values shows what is stored on this component, not the value in effect; the built setting reports that.

Available options:
INHERITED,
LOCAL,
PARAMETER
values
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 this setting's type. The properties listed here are common examples only and are not required.