Batch update component settings
curl --request PUT \
--url https://api.extole.io/v1/components/{component_id}/settings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"settings_key": {
"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"
payload = { "settings": { "settings_key": {
"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({
settings: {
settings_key: {
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', 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",
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([
'settings' => [
'settings_key' => [
'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"
payload := strings.NewReader("{\n \"settings\": {\n \"settings_key\": {\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 }\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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"settings_key\": {\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 }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings")
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 \"settings\": {\n \"settings_key\": {\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 }\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": {}
}
}
]Components
Batch update component settings
Applies a batch of setting value updates across the component in one request. A different type on an entry changes the type of that setting; the type field says what carries over and which errors apply.
Fields omitted from the body are left unchanged, except settings, which the request schema marks required and which every request must send.
PUT
https://api.extole.io
/
v1
/
components
/
{component_id}
/
settings
Batch update component settings
curl --request PUT \
--url https://api.extole.io/v1/components/{component_id}/settings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"settings": {
"settings_key": {
"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"
payload = { "settings": { "settings_key": {
"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({
settings: {
settings_key: {
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', 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",
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([
'settings' => [
'settings_key' => [
'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"
payload := strings.NewReader("{\n \"settings\": {\n \"settings_key\": {\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 }\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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settings\": {\n \"settings_key\": {\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 }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings")
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 \"settings\": {\n \"settings_key\": {\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 }\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
application/json
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
description
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
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.
Available options:
INHERITED, LOCAL, PARAMETER Was this page helpful?