Enable or disable a channel

Enables or disables a channel without disconnecting it. A disabled channel keeps its configuration, automation rules and conversation history, stops delivering events, and **does not occupy a slot against your plan** — capacity counts enabled channels only. This is how you bring channels back after renewing a lapsed plan. Enabling is checked against your plan at that moment, so you can never exceed your capacity by toggling. Disabling never requires capacity and always succeeds.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Path parameters

robot_idstringRequired
The robot's id, as returned by the create call.
channel_idstringRequired
The channel's id.

Request

This endpoint expects an object.
is_activebooleanRequired

true enables the channel and occupies a capacity slot. false disables it and frees the slot.

Response

The updated channel.
idstringOptional
ParsChat identifier for the channel.
typeenumOptional
The kind of surface this channel connects.
robot_idstringOptional
The robot that owns this channel.
usernamestringOptional
The connected account's handle. Present once the page owner has authorised.
is_activebooleanOptional
Whether the channel is receiving traffic. False while a handshake is pending or after a plan lapses.
connected_atdatetimeOptional
When the channel went live.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error