Update a component
curl --request PUT \
--url https://api.extole.io/v1/components/{component_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"display_name": "display_name",
"facets": [
{
"name": "name",
"value": "value"
}
],
"install": {},
"installed_into_socket": "installed_into_socket",
"name": "name",
"settings": [
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "ADMIN_ICON",
"values": {
"values_key": {}
}
}
],
"tags": [
"tag"
],
"types": [
"type"
],
"upload_version": "upload_version"
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"display_name": "display_name",
"facets": [
{
"name": "name",
"value": "value"
}
],
"install": {},
"installed_into_socket": "installed_into_socket",
"name": "name",
"settings": [
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": ["tag"],
"type": "ADMIN_ICON",
"values": { "values_key": {} }
}
],
"tags": ["tag"],
"types": ["type"],
"upload_version": "upload_version"
}
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({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
display_name: 'display_name',
facets: [{name: 'name', value: 'value'}],
install: {},
installed_into_socket: 'installed_into_socket',
name: 'name',
settings: [
{
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
source: 'INHERITED',
tags: ['tag'],
type: 'ADMIN_ICON',
values: {values_key: {}}
}
],
tags: ['tag'],
types: ['type'],
upload_version: 'upload_version'
})
};
fetch('https://api.extole.io/v1/components/{component_id}', 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}",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'display_name' => 'display_name',
'facets' => [
[
'name' => 'name',
'value' => 'value'
]
],
'install' => [
],
'installed_into_socket' => 'installed_into_socket',
'name' => 'name',
'settings' => [
[
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'ADMIN_ICON',
'values' => [
'values_key' => [
]
]
]
],
'tags' => [
'tag'
],
'types' => [
'type'
],
'upload_version' => 'upload_version'
]),
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}"
payload := strings.NewReader("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\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}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}")
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 \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"description": "<string>",
"filename": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
],
"campaign_id": "<string>",
"campaign_state": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"created_date": "2025-10-24T02:00:00-07:00",
"description": "<string>",
"display_name": "<string>",
"facets": [
{
"name": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"install": {},
"installed_into_socket": "<string>",
"name": "<string>",
"origin": {
"client_id": "<string>",
"component_id": "<string>",
"component_version": 123
},
"owner": "CLIENT",
"source_client_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"types": [
"<string>"
],
"updated_date": "2025-10-24T02:00:00-07:00",
"upload_version": "<string>",
"variables": [
{
"description": "<string>",
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"source": "INHERITED",
"values": {
"default": {},
"en": {}
}
}
],
"version": 123
}Components
Update a component
Updates component identity and metadata from a JSON body.
PUT
/
v1
/
components
/
{component_id}
Update a component
curl --request PUT \
--url https://api.extole.io/v1/components/{component_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"description": "description",
"display_name": "display_name",
"facets": [
{
"name": "name",
"value": "value"
}
],
"install": {},
"installed_into_socket": "installed_into_socket",
"name": "name",
"settings": [
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": [
"tag"
],
"type": "ADMIN_ICON",
"values": {
"values_key": {}
}
}
],
"tags": [
"tag"
],
"types": [
"type"
],
"upload_version": "upload_version"
}
'import requests
url = "https://api.extole.io/v1/components/{component_id}"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"description": "description",
"display_name": "display_name",
"facets": [
{
"name": "name",
"value": "value"
}
],
"install": {},
"installed_into_socket": "installed_into_socket",
"name": "name",
"settings": [
{
"description": "description",
"display_name": "display_name",
"name": "name",
"priority": "10",
"source": "INHERITED",
"tags": ["tag"],
"type": "ADMIN_ICON",
"values": { "values_key": {} }
}
],
"tags": ["tag"],
"types": ["type"],
"upload_version": "upload_version"
}
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({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
description: 'description',
display_name: 'display_name',
facets: [{name: 'name', value: 'value'}],
install: {},
installed_into_socket: 'installed_into_socket',
name: 'name',
settings: [
{
description: 'description',
display_name: 'display_name',
name: 'name',
priority: '10',
source: 'INHERITED',
tags: ['tag'],
type: 'ADMIN_ICON',
values: {values_key: {}}
}
],
tags: ['tag'],
types: ['type'],
upload_version: 'upload_version'
})
};
fetch('https://api.extole.io/v1/components/{component_id}', 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}",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'description' => 'description',
'display_name' => 'display_name',
'facets' => [
[
'name' => 'name',
'value' => 'value'
]
],
'install' => [
],
'installed_into_socket' => 'installed_into_socket',
'name' => 'name',
'settings' => [
[
'description' => 'description',
'display_name' => 'display_name',
'name' => 'name',
'priority' => '10',
'source' => 'INHERITED',
'tags' => [
'tag'
],
'type' => 'ADMIN_ICON',
'values' => [
'values_key' => [
]
]
]
],
'tags' => [
'tag'
],
'types' => [
'type'
],
'upload_version' => 'upload_version'
]),
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}"
payload := strings.NewReader("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\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}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}")
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 \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"description\": \"description\",\n \"display_name\": \"display_name\",\n \"facets\": [\n {\n \"name\": \"name\",\n \"value\": \"value\"\n }\n ],\n \"install\": {},\n \"installed_into_socket\": \"installed_into_socket\",\n \"name\": \"name\",\n \"settings\": [\n {\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 }\n ],\n \"tags\": [\n \"tag\"\n ],\n \"types\": [\n \"type\"\n ],\n \"upload_version\": \"upload_version\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"description": "<string>",
"filename": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
],
"campaign_id": "<string>",
"campaign_state": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"created_date": "2025-10-24T02:00:00-07:00",
"description": "<string>",
"display_name": "<string>",
"facets": [
{
"name": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"install": {},
"installed_into_socket": "<string>",
"name": "<string>",
"origin": {
"client_id": "<string>",
"component_id": "<string>",
"component_version": 123
},
"owner": "CLIENT",
"source_client_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"types": [
"<string>"
],
"updated_date": "2025-10-24T02:00:00-07:00",
"upload_version": "<string>",
"variables": [
{
"description": "<string>",
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"source": "INHERITED",
"values": {
"default": {},
"en": {}
}
}
],
"version": 123
}Authorizations
HEADERQUERYCOOKIE
Path Parameters
Body
application/json
Body of a PUT /v1/components/{component_id}{version:(/version/.+)?} request.
Show child attributes
Show child attributes
Choose between static or dynamic display name. Buildtime expressions use CampaignBuildtimeContext.
Show child attributes
Show child attributes
install
Static Value · Static Value · objectInstalltime - Handlebars · stringInstalltime - Javascript · string
Choose between static or dynamic install. Installtime expressions use ComponentInstalltimeContext.
- 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
Show child attributes
Show child attributes
Response
Successful response
Stored component definition. Field display_name is unevaluated and appears in buildtime-evaluatable form.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$Example:
"2025-10-24T02:00:00-07:00"
display_name
Static Value · stringBuildtime - Handlebars · stringBuildtime - Javascript · string
required
The display name as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.
Show child attributes
Show child attributes
install
Static Value · Static Value · objectInstalltime - Handlebars · stringInstalltime - Javascript · string
required
The install as configured: a literal value, or an expression (type:string) when defined dynamically. Installtime expressions use ComponentInstalltimeContext.
Show child attributes
Show child attributes
Available options:
CLIENT, EXTOLE, EXTOLE_BETA RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$Example:
"2025-10-24T02:00:00-07:00"
- 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
Show child attributes
Show child attributes
⌘I