curl --request POST \
--url https://api.extole.io/v1/components/{component_id}/settings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "ADMIN_ICON",
"values": {
"values_key": {}
}
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings"
payload = {
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": ["tag"],
"type": "ADMIN_ICON",
"values": { "values_key": {} }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
source: 'INHERITED',
tags: ['tag'],
type: 'ADMIN_ICON',
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'ADMIN_ICON',
'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 \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\n \"values\": {\n \"values_key\": {}\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.extole.io/v1/components/{component_id}/settings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\n \"values\": {\n \"values_key\": {}\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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\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": {}
}
}Create a component setting
Adds a new named configuration setting to the specified component. Returns the created setting.
curl --request POST \
--url https://api.extole.io/v1/components/{component_id}/settings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "ADMIN_ICON",
"values": {
"values_key": {}
}
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings"
payload = {
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": ["tag"],
"type": "ADMIN_ICON",
"values": { "values_key": {} }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
source: 'INHERITED',
tags: ['tag'],
type: 'ADMIN_ICON',
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'ADMIN_ICON',
'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 \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\n \"values\": {\n \"values_key\": {}\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.extole.io/v1/components/{component_id}/settings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\n \"values\": {\n \"values_key\": {}\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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"name\": \"name\",\n \"priority\": \"10\",\n \"source\": \"INHERITED\",\n \"tags\": [\n \"tag\"\n ],\n \"type\": \"ADMIN_ICON\",\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": {}
}
}Authorizations
Path Parameters
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
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 "10"
Choose between static or dynamic description. Buildtime expressions use VariableDescriptionBuildtimeContext.
INHERITED, LOCAL, PARAMETER 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.
Show child attributes
Show child attributes
Response
Successful response
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
The description as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.
"10"
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 INHERITED, LOCAL, PARAMETER 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.
Show child attributes
Show child attributes
