Skip to main content
PATCH
Update 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:update
chat:moderate
support_chat:create

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Public resource ID.

Corps

application/json
icon
object | null

Channel icon as a file reference, for community channels and group private channels. Image files only. Group icons can be up to 5 MB. For community channels it sets the experience logo, and null restores the app icon. For group private channels it sets the channel's own icon, and null clears it. Omit to keep the current icon.

moderation
object

Moderation settings, accepted only for community channels. Requires chat moderation permission. Omitted settings are preserved.

name
string | null

Replacement display name for any channel kind. Send null to clear a private or support channel name. Community channels require a name and also rename the experience.

Maximum string length: 255
Pattern: \S
Exemple:

"Renamed"

notifications_enabled
boolean

Whether app notifications are on for any channel kind. Webhooks fire either way. Omit to preserve the current setting.

Réponse

operation completed

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"