# WhatsApp channel operations

Exact methods, permissions, request bodies and query fields for whatsapp channel operations.

## Get all subscribed channels/newsletters

GET /api/v1/channels/{channel_id}/channels

Token scope: read. Paid access and a ready, customer-owned session are required. List responses are bounded; use documented pagination parameters.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.







```json
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}
```





## Create a channel

POST /api/v1/channels/{channel_id}/channels

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.



- `name` (string, required): Maximum 100 characters. See JSON schema for all validation constraints.
- `description` (string): Maximum 2048 characters. See JSON schema for all validation constraints.



```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100
    },
    "description": {
      "type": "string",
      "maxLength": 2048
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}
```





## Get a specific channel by ID

GET /api/v1/channels/{channel_id}/channels/{channelId}

Token scope: read. Paid access and a ready, customer-owned session are required. List responses are bounded; use documented pagination parameters.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.







```json
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}
```





## Unsubscribe from a channel

DELETE /api/v1/channels/{channel_id}/channels/{channelId}

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.







```json
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}
```





## Get messages from a channel

GET /api/v1/channels/{channel_id}/channels/{channelId}/messages

Token scope: read. Paid access and a ready, customer-owned session are required. List responses are bounded; use documented pagination parameters.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.





Query parameter | Required | Schema
--- | --- | ---
limit | No | {"type":"integer","minimum":1,"maximum":100}

```json
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}
```





## Delete a channel this account owns

POST /api/v1/channels/{channel_id}/channels/{channelId}/delete

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.







```json
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}
```





## Mute or unmute a channel

POST /api/v1/channels/{channel_id}/channels/{channelId}/mute

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.



- `mute` (boolean, required): See JSON schema for all validation constraints.



```json
{
  "type": "object",
  "properties": {
    "mute": {
      "type": "boolean"
    }
  },
  "required": [
    "mute"
  ],
  "additionalProperties": false
}
```





## Demote a channel admin back to a subscriber

POST /api/v1/channels/{channel_id}/channels/{channelId}/admins/demote

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.



- `userId` (string, required): Maximum 4096 characters. See JSON schema for all validation constraints.



```json
{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "userId"
  ],
  "additionalProperties": false
}
```





## Transfer channel ownership to another account

POST /api/v1/channels/{channel_id}/channels/{channelId}/owner/transfer

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.



- `newOwnerId` (string, required): Maximum 4096 characters. See JSON schema for all validation constraints.



```json
{
  "type": "object",
  "properties": {
    "newOwnerId": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "newOwnerId"
  ],
  "additionalProperties": false
}
```





## Subscribe to a channel using invite code

POST /api/v1/channels/{channel_id}/channels/subscribe

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.



- `inviteCode` (string, required): Maximum 4096 characters. See JSON schema for all validation constraints.



```json
{
  "type": "object",
  "properties": {
    "inviteCode": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "inviteCode"
  ],
  "additionalProperties": false
}
```