Channels

Channels

Get available channels

get

Fetch the list of available channels and indicate whether each is installed.

Path parameters
workspaceIdstringRequired

The ID of the workspace

Example: d587ce39-6be2-48c0-b400-5d776464a112
Responses
200

List of available channels with installation status

application/json
get
/api/channels/{workspaceId}/available

Get WhatsApp setup information

get

Fetch detailed information required to set up WhatsApp as a channel.

Responses
200

WhatsApp setup information

application/json
get
/api/channels/whatsapp/setup-info

Install a channel for a connector

post

Install a channel and link it to an existing connector.

Path parameters
workspace_idstring · uuidRequired

The workspace ID

Example: d587ce39-6be2-48c0-b400-5d776464a112
Body
connector_idstring · uuidOptional

The ID of the connector

namestringOptional

Name of the channel

platformstring · enumOptional

Platform of the channel

Possible values:
Responses
200

Channel installed successfully

No content

post
/api/workspaces/{workspace_id}/channels/install

No content

Get channels with optional platform filter

get

Fetch the list of channels for a workspace, optionally filtering by platform.

Path parameters
workspaceIdstringRequired

The ID of the workspace

Example: 04c51660-196a-468a-bf97-3fcef058944d
Query parameters
platformstringOptional

Platform to filter channels by (e.g., whatsapp)

Example: whatsapp
statusstringOptional

status to filter channels by (e.g., active)

Example: whatsapp
Responses
200

List of channels with optional platform filter

application/json
get
/api/workspaces/{workspaceId}/channels

Get channels by organization with optional platform filter

get

Fetch all channels associated with an organization's workspaces, optionally filtered by platform.

Path parameters
organizationIdstring · uuidRequired

The ID of the organization

Query parameters
platformstring · enumOptional

Platform to filter channels by (e.g., whatsapp, sms)

Possible values:
Responses
200

List of channels for the organization

application/json
get
/api/organizations/{organizationId}/channels

Connect a channel to a workspace

post

Associate an existing channel with a specific workspace

Path parameters
workspace_idstring · uuidRequired

The ID of the workspace

channel_idstring · uuidRequired

The ID of the channel to connect

Responses
200

Channel connected successfully

application/json
post
/api/workspaces/{workspace_id}/channels/{channel_id}/connect

Last updated