Upgrade a component

curl --request POST \
  --url https://api.extole.io/v1/components/{component_id}/upgrade \
  --header 'Authorization: <api-key>'

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v1/components/{component_id}/upgrade', 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}/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v1/components/{component_id}/upgrade"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v1/components/{component_id}/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

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
  },
  "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",
      "values": {
        "default": {},
        "en": {}
      }
    }
  ],
  "version": 123
}

POST

components

{component_id}

upgrade

Upgrade a component

curl --request POST \
  --url https://api.extole.io/v1/components/{component_id}/upgrade \
  --header 'Authorization: <api-key>'

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v1/components/{component_id}/upgrade', 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}/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v1/components/{component_id}/upgrade"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v1/components/{component_id}/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

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
  },
  "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",
      "values": {
        "default": {},
        "en": {}
      }
    }
  ],
  "version": 123
}

Authorizations

Authorization

string

header

required

Path Parameters

component_id

string

required

Response

Successful response

Stored component definition. Field display_name is unevaluated and appears in buildtime-evaluatable form.

assets

object[]

required

Show child attributes

campaign_id

string

required

campaign_state

string

required

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_date

string

required

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"

description

string

required

display_name

required

The display name as configured: a literal value, or an expression (type:string) when defined dynamically.

facets

object[]

required

Show child attributes

string

required

read-only

install

required

The install as configured: a literal value, or an expression (type:string) when defined dynamically.

installed_into_socket

string

required

name

string

required

origin

object

required

Show child attributes

owner

enum<string>

required

Available options:

CLIENT,

EXTOLE,

EXTOLE_BETA

source_client_id

string

required

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Upgrade a component

Authorizations

Path Parameters

Response