Update a channel, or archive it with `enabled: false`.
curl --request PATCH \
--url https://api.sigmora.org/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"niche": "<string>",
"description": "<string>",
"accentColor": "<string>",
"voicePreset": "<string>",
"products": [
"<string>"
],
"enabled": true
}
'import requests
url = "https://api.sigmora.org/v1/channels/{channelId}"
payload = {
"name": "<string>",
"niche": "<string>",
"description": "<string>",
"accentColor": "<string>",
"voicePreset": "<string>",
"products": ["<string>"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
niche: '<string>',
description: '<string>',
accentColor: '<string>',
voicePreset: '<string>',
products: ['<string>'],
enabled: true
})
};
fetch('https://api.sigmora.org/v1/channels/{channelId}', 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.sigmora.org/v1/channels/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'niche' => '<string>',
'description' => '<string>',
'accentColor' => '<string>',
'voicePreset' => '<string>',
'products' => [
'<string>'
],
'enabled' => true
]),
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.sigmora.org/v1/channels/{channelId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sigmora.org/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmora.org/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}API Reference
Update a channel, or archive it with `enabled: false`.
PATCH
/
v1
/
channels
/
{channelId}
Update a channel, or archive it with `enabled: false`.
curl --request PATCH \
--url https://api.sigmora.org/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"niche": "<string>",
"description": "<string>",
"accentColor": "<string>",
"voicePreset": "<string>",
"products": [
"<string>"
],
"enabled": true
}
'import requests
url = "https://api.sigmora.org/v1/channels/{channelId}"
payload = {
"name": "<string>",
"niche": "<string>",
"description": "<string>",
"accentColor": "<string>",
"voicePreset": "<string>",
"products": ["<string>"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
niche: '<string>',
description: '<string>',
accentColor: '<string>',
voicePreset: '<string>',
products: ['<string>'],
enabled: true
})
};
fetch('https://api.sigmora.org/v1/channels/{channelId}', 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.sigmora.org/v1/channels/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'niche' => '<string>',
'description' => '<string>',
'accentColor' => '<string>',
'voicePreset' => '<string>',
'products' => [
'<string>'
],
'enabled' => true
]),
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.sigmora.org/v1/channels/{channelId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sigmora.org/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmora.org/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"niche\": \"<string>\",\n \"description\": \"<string>\",\n \"accentColor\": \"<string>\",\n \"voicePreset\": \"<string>\",\n \"products\": [\n \"<string>\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}Authorizations
A workspace API key.
Path Parameters
Required string length:
1 - 200Body
application/json
Required string length:
1 - 120Maximum string length:
200Maximum string length:
2000Maximum string length:
32Named voice preset the engine writes this channel in.
Maximum string length:
120Product binding ids (from /v1/products), or 'none' to declare this channel promotes nothing. An empty array means 'nothing bound yet'; 'none' means 'deliberately never' — the engine reads the difference.
Maximum array length:
50Required string length:
1 - 40Set false to archive. There is no delete.
⌘I