Skip to main content
POST
Create Channel

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

dms:channel:manage
experience:create
support_chat:message:create
support_chat:create

En-têtes

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Exemple:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Corps

application/json
kind
enum<string>
requis

Channel kind. private is a one-to-one or group conversation, community creates a Chat experience on the account, and support opens a conversation between the account and a customer.

Options disponibles:
private,
community,
support
Exemple:

"private"

account_id
string

Owning account ID, prefixed biz_. Accepted for all channel kinds. Required for community and support channels unless supplied by the credential's account context.

Pattern: \S
Exemple:

"biz_xxxxxxxxxxxxxx"

customer_user_id
string

Customer ID, prefixed user_. Support channels only; requires support management permission. Omit to open your own support conversation.

Pattern: \S
icon
object

Channel icon as a file reference, for community channels and private channels with two or more participant IDs. Image files only. Group icons can be up to 5 MB. For community channels it sets the experience logo. Used only when a channel is created.

name
string

Channel display name, accepted for all channel kinds. Used only when a channel is created. For community channels, names the new Chat experience; defaults to the Chat app's name.

Maximum string length: 255
Pattern: \S
notifications_enabled
boolean

Whether app notifications are on for any channel kind. Webhooks fire either way. Defaults to true. Used only when a channel is created; change an existing channel with PATCH /channels/:id.

participant_user_ids
string[]

Other participant IDs, prefixed user_, excluding the sender. Required for private channels and accepted only for them. One ID creates a one-to-one conversation; more create a group.

Required array length: 1 - 49 elements
Pattern: \S
product_id
string

Product ID, prefixed prod_, to attach the new community channel to. Accepted only for community channels. Must belong to the owning account and requires the experience:attach permission on it. Omit to leave the channel unattached.

Pattern: \S
sender_user_id
string

Sender ID, prefixed user_. Private channels only. Required for account API keys; omit when authenticating as a user. Requires channel management permission on the account.

Pattern: \S

Réponse

existing channel returned

account_id
string | null
requis
Exemple:

"biz_xxxxxxxxxxxxxx"

created_at
string
requis

Creation time as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

deleted_at
string | null
requis

When the channel was deleted or removed from your channel list, as an ISO 8601 timestamp. Null for a live channel.

Exemple:

null

experience_id
string | null
requis
Exemple:

null

icon
object | null
requis

The channel icon. Community channels show the experience logo, falling back to the app icon. Support channels show the account logo. Group private channels show their own icon. Null for one-to-one private channels or when no image is set.

id
string
requis

Existing public channel ID, preserved across REST and chat clients.

Exemple:

"feed_xxxxxxxxxxxxxxxxxxxxxx"

kind
enum<string>
requis
Options disponibles:
private,
community,
support
Exemple:

"private"

last_message_at
string | null
requis

When the channel last recorded message activity, as an ISO 8601 timestamp. Null when no message activity is recorded.

Exemple:

"2026-01-01T12:00:00.000Z"

last_message_id
string | null
requis
Exemple:

"post_xxxxxxxxxxxxxxxxxxxxxx"

membership
object | null
requis
moderation
object | null
requis
name
string | null
requis
Exemple:

"Renamed"

notifications_enabled
boolean
requis

Whether app notifications are on. Webhooks fire either way.

Exemple:

true

support
object | null
requis
updated_at
string
requis

Last channel change as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"