Skip to main content
Create Or Update Chat Starter Settings For A Registered Agent
curl --request PUT \
  --url https://{api_endpoint}/v1/orchestrate/agents/{id}/chat-starter-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "starter_prompts": {
    "customize": [
      {
        "title": "<string>",
        "prompt": "<string>",
        "id": "<string>",
        "subtitle": "<string>",
        "state": "<string>"
      }
    ]
  },
  "welcome_content": {
    "welcome_message": "<string>",
    "description": "<string>",
    "is_default_voice_greeting": false
  },
  "icon": "<string>"
}
'
import requests

url = "https://{api_endpoint}/v1/orchestrate/agents/{id}/chat-starter-settings"

payload = {
"starter_prompts": { "customize": [
{
"title": "<string>",
"prompt": "<string>",
"id": "<string>",
"subtitle": "<string>",
"state": "<string>"
}
] },
"welcome_content": {
"welcome_message": "<string>",
"description": "<string>",
"is_default_voice_greeting": False
},
"icon": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
starter_prompts: {
customize: [
{
title: '<string>',
prompt: '<string>',
id: '<string>',
subtitle: '<string>',
state: '<string>'
}
]
},
welcome_content: {
welcome_message: '<string>',
description: '<string>',
is_default_voice_greeting: false
},
icon: '<string>'
})
};

fetch('https://{api_endpoint}/v1/orchestrate/agents/{id}/chat-starter-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_endpoint}/v1/orchestrate/agents/{id}/chat-starter-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([
'starter_prompts' => [
'customize' => [
[
'title' => '<string>',
'prompt' => '<string>',
'id' => '<string>',
'subtitle' => '<string>',
'state' => '<string>'
]
]
],
'welcome_content' => [
'welcome_message' => '<string>',
'description' => '<string>',
'is_default_voice_greeting' => false
],
'icon' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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_endpoint}/v1/orchestrate/agents/{id}/chat-starter-settings"

payload := strings.NewReader("{\n \"starter_prompts\": {\n \"customize\": [\n {\n \"title\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"state\": \"<string>\"\n }\n ]\n },\n \"welcome_content\": {\n \"welcome_message\": \"<string>\",\n \"description\": \"<string>\",\n \"is_default_voice_greeting\": false\n },\n \"icon\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
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_endpoint}/v1/orchestrate/agents/{id}/chat-starter-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"starter_prompts\": {\n \"customize\": [\n {\n \"title\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"state\": \"<string>\"\n }\n ]\n },\n \"welcome_content\": {\n \"welcome_message\": \"<string>\",\n \"description\": \"<string>\",\n \"is_default_voice_greeting\": false\n },\n \"icon\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_endpoint}/v1/orchestrate/agents/{id}/chat-starter-settings")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"starter_prompts\": {\n \"customize\": [\n {\n \"title\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"subtitle\": \"<string>\",\n \"state\": \"<string>\"\n }\n ]\n },\n \"welcome_content\": {\n \"welcome_message\": \"<string>\",\n \"description\": \"<string>\",\n \"is_default_voice_greeting\": false\n },\n \"icon\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json

A specification for chat starter settings within an agent

starter_prompts
AgentCustomizedPromptsIn · object | null

Agent Starter Prompts

welcome_content
AgentWelcomeContentIn · object | null

Agent Welcome Message

icon
string | null

Agent Icon (SVG)

Response

Successful Response