Skip to main content
POST
Create a component setting

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required

Body

application/json
name
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
display_name
string
priority
string
Example:

"10"

tags
string[]
description

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

source
enum<string>
Available options:
INHERITED,
LOCAL,
PARAMETER
values
object

The setting's values, normally keyed by locale, with default as the fallback key. Omit this property to leave the stored values as they are. Supplying it replaces the whole map rather than merging key by key, so {"default": "$40"} leaves the setting with default alone and drops every other key it had.

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>
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.