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.
Retrieve a list of all channel groups
The ID of the workspace
GET /workspaces/{workspaceId}/channel-groups HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
List of available channel groups is returned
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"platformGroupId": "text",
"platformGroupName": "text",
"platformId": "text",
"channelIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2025-06-22T18:47:29.444Z",
"updatedAt": "2025-06-22T18:47:29.444Z"
}
]
}
Get channel group by ID
This endpoint gets a channel group by group ID and lists all the channels related to the group
Retrieve channel group by it's type
The ID of the workspace
The ID for a channel group
GET /workspaces/{workspaceId}/channel-groups/{channelGroupId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"platformGroupId": "text",
"platformGroupName": "text",
"platformId": "text",
"channelIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"createdAt": "2025-06-22T18:47:29.444Z",
"updatedAt": "2025-06-22T18:47:29.444Z"
}
Last updated
Was this helpful?