curl --request PUT \
--url https://api.extole.io/v1/components/{component_id}/settings/{setting_name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"authorization_url": "authorization_url",
"client_secret_key_id": "client_secret_key_id",
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"redirect_url": "redirect_url",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "CLIENT_KEY_FLOW",
"values": {
"values_key": {}
}
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}"
payload = {
"authorization_url": "authorization_url",
"client_secret_key_id": "client_secret_key_id",
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"redirect_url": "redirect_url",
"source": "INHERITED",
"tags": ["tag"],
"type": "CLIENT_KEY_FLOW",
"values": { "values_key": {} }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authorization_url: 'authorization_url',
client_secret_key_id: 'client_secret_key_id',
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
redirect_url: 'redirect_url',
source: 'INHERITED',
tags: ['tag'],
type: 'CLIENT_KEY_FLOW',
values: {values_key: {}}
})
};
fetch('https://api.extole.io/v1/components/{component_id}/settings/{setting_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'authorization_url' => 'authorization_url',
'client_secret_key_id' => 'client_secret_key_id',
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'redirect_url' => 'redirect_url',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'CLIENT_KEY_FLOW',
'values' => [
'values_key' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}"
payload := strings.NewReader("{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.extole.io/v1/components/{component_id}/settings/{setting_name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings/{setting_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"source": "INHERITED",
"values": {
"default": {},
"en": {}
}
}Update a component setting
Updates the specified component setting. Only fields present in the request body are changed. Returns the updated setting. A different type changes the type of the setting; the type field says what carries over and which errors apply.
curl --request PUT \
--url https://api.extole.io/v1/components/{component_id}/settings/{setting_name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"authorization_url": "authorization_url",
"client_secret_key_id": "client_secret_key_id",
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"redirect_url": "redirect_url",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "CLIENT_KEY_FLOW",
"values": {
"values_key": {}
}
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}"
payload = {
"authorization_url": "authorization_url",
"client_secret_key_id": "client_secret_key_id",
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"redirect_url": "redirect_url",
"source": "INHERITED",
"tags": ["tag"],
"type": "CLIENT_KEY_FLOW",
"values": { "values_key": {} }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authorization_url: 'authorization_url',
client_secret_key_id: 'client_secret_key_id',
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
redirect_url: 'redirect_url',
source: 'INHERITED',
tags: ['tag'],
type: 'CLIENT_KEY_FLOW',
values: {values_key: {}}
})
};
fetch('https://api.extole.io/v1/components/{component_id}/settings/{setting_name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'authorization_url' => 'authorization_url',
'client_secret_key_id' => 'client_secret_key_id',
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'redirect_url' => 'redirect_url',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'CLIENT_KEY_FLOW',
'values' => [
'values_key' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v1/components/{component_id}/settings/{setting_name}"
payload := strings.NewReader("{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.extole.io/v1/components/{component_id}/settings/{setting_name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings/{setting_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authorization_url\": \"authorization_url\",\n \"client_secret_key_id\": \"client_secret_key_id\",\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"redirect_url\": \"redirect_url\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"CLIENT_KEY_FLOW\",\n \"values\": {\n \"values_key\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"source": "INHERITED",
"values": {
"default": {},
"en": {}
}
}Body
- CLIENT_KEY_FLOW
- COMPONENT_ID
- COMPONENT_REFERENCE
- COMPONENT_REFERENCE_LIST
- COMPONENT_SETTING_LOOKUP
- ENUM
- ENUM_LIST
- MULTI_SOCKET
- PARTNER_ENUM
- PARTNER_ENUM_LIST
- REWARD_SUPPLIER_ID_LIST
- SFTP_DIRECTORY
- SOCKET
- STRING_MAP
- TRIGGER_CONFIGURATION
Body of a PUT /v2/campaigns/{campaign_id}{version:(/version/.+)?}/components/{component_id}/variables/{setting_name} request.
Type of the setting. When omitted, the setting keeps its stored type. A different type changes the setting to that type. When the new type has no field that the stored type lacks, every field carries over, for example between ENUM and ENUM_LIST, or SOCKET and MULTI_SOCKET. Otherwise the name, display name, description, tags, priority, values and source carry over, and the request sends the other fields of the new type. A variable and a socket cannot change into each other: unexpected_setting_type. A MULTI_SOCKET changes to SOCKET only while one component is installed into it: multiple_components_installed_into_single_socket. A change to a type with a field that the stored type lacks cannot also change the source from INHERITED to LOCAL: setting_validation_exception.
CLIENT_KEY_FLOW Choose between static or dynamic description. Buildtime expressions use VariableDescriptionBuildtimeContext.
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 values onto this component. Changing it to LOCAL with values stores only the values sent, so send every locale the setting should keep. Either way, assets of the ancestor component that the stored values reference are copied onto this component.
INHERITED, LOCAL, PARAMETER Values to store on this component, keyed by locale or default. Omit to leave them unchanged. The map sent replaces every stored value, so a locale not sent is removed. Sending values does not change source: an INHERITED setting keeps using its ancestor's value until source is set to LOCAL.
Show child attributes
Show child attributes
Response
Successful response
- ADMIN_ICON
- AUDIENCE_ID
- AUDIENCE_ID_LIST
- BOOLEAN
- BROWSER_SIDE_JAVASCRIPT
- CLIENT_DOMAIN_ID
- CLIENT_DOMAIN_ID_LIST
- CLIENT_KEY
- CLIENT_KEY_FLOW
- COLOR
- COMPONENT_ID
- COMPONENT_REFERENCE
- COMPONENT_REFERENCE_LIST
- COMPONENT_SETTING_LOOKUP
- CSS
- DATE_TIME
- DELAY
- DELAY_LIST
- ENUM
- ENUM_LIST
- EXTOLE_CLIENT_KEY
- FONT
- GLOB_COMPONENT_PATH
- HTML
- IMAGE
- INTEGER
- INTEGER_LIST
- JSON
- MULTI_SOCKET
- PARTNER_ENUM
- PARTNER_ENUM_LIST
- PERSON_KEY_NAME
- REWARD_SUPPLIER_ID
- REWARD_SUPPLIER_ID_LIST
- SFTP_DIRECTORY
- SOCKET
- STRING
- STRING_LIST
- STRING_MAP
- TRIGGER_CONFIGURATION
- URL
- WEBHOOK_ID
The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.
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.
INHERITED, LOCAL, PARAMETER Was this page helpful?