Create a new channel

POST

/channels

Create a new WhatsApp channel (Meta, GreenAPI, or Officely)

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Channel created successfully

Bodyapplication/json

🟠400Bad Request

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/channels' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "channelType": "whatsapp_cloud",
    "name": "string",
    "phoneNumber": "string",
    "accessToken": "string"
}'

Response Example

201 - Example 1

{
    "id": 0,
    "channel_type": "whatsapp_cloud",
    "name": "string",
    "phone_number": "string",
    "is_active": true,
    "created_at": "2019-08-24T14:15:22.123Z"
}

Modified at 2025-12-13 02:50:35

List all channels

Get channel by ID