Skip to main content
POST
Create a channel. Only a name is required.

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
name
string
required

The only required field.

Required string length: 1 - 120
niche
string
Maximum string length: 200
description
string
Maximum string length: 2000
accentColor
string

Brand colour, e.g. #d66428.

Maximum string length: 32
voicePreset
string

Named voice preset the engine writes this channel in.

Maximum string length: 120
products

Product 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: 50
Required string length: 1 - 40

Response

Success.

success
boolean
required
{key}
any