Channel Groups

The following endpoints are part of the Channels API and allow you to manage channel groups, specifically for the WhatsApp platform. Channel groups are used to group together channel IDs that belong to the same WhatsApp account. This documentation will provide details on how to interact with these endpoints.

List available channel groups

This endpoint retrieves a list of all available channel groups within a workspace. The response includes information such as the unique identifier of each channel group, the WhatsApp platform ID, the platform group ID, the platform group name, and the list of channel IDs associated with the channel group.

List available channel groups

Retrieve a list of all channel groups

get

/workspaces/{workspaceId}/channel-groups

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channel-groups' \
  --header 'Authorization: Bearer jwt'

200

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "platformGroupId": "text",
      "platformGroupName": "text",
      "platformId": "text",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "2025-02-21T18:05:30.441Z",
      "updatedAt": "2025-02-21T18:05:30.441Z"
    }
  ]
}

List of available channel groups is returned

Get channel group by ID

This endpoint gets a channel group by group ID and lists all the channels related to the group

Get channel group by ID

Retrieve channel group by it's type

get

/workspaces/{workspaceId}/channel-groups/{channelGroupId}

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

channelGroupIdstring · uuidrequired

The ID for a channel group

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channel-groups/{channelGroupId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "platformGroupId": "text",
  "platformGroupName": "text",
  "platformId": "text",
  "channelIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2025-02-21T18:05:30.441Z",
  "updatedAt": "2025-02-21T18:05:30.441Z"
}

Return channel group