WhatsApp Gateway
API referenceChannels

Create a channel (newsletter)

POST
/api/v1/sessions/{session}/channels

Create a WhatsApp channel owned by this session and return its JID.

Current behavior is not_implemented (501): request shape is validated but channel is not created yet.

Requires send capability.

Errors: forbidden (403), not_found (404), not_implemented (501), validation_error (400).

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

Session ID that owns the channel. Must belong to your organization.

Example"01HX..."

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

Optional channel description.

Example"Product updates and release notes."
name?string

Channel name. Optional in payload; empty or invalid names are rejected as validation_error (400).

Example"Acme Announcements"

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/sessions/01HX.../channels" \  -H "Content-Type: application/json" \  -d '{}'
{  "jid": "string"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}