Create a new channel

POST/v1/channels

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

configany

Provider-specific configuration

metadataany

Arbitrary metadata

modestring

Channel mode

default: "single"

Allowed:singlehybrid

namestringrequired

Channel name

min length 1

phonestring

Phone number

platformstringrequired

Platform type

Allowed:whatsapp_officialwhatsapp_unofficialinstagrammessengertelegramsms

Responses

201Created

configany

created_atstringrequired

health_statestring

Operator-facing health: healthy, auth_required, degraded, setup_required

idstringrequired

is_activebooleanrequired

last_connected_atstring | nullrequired

last_errorstring | nullrequired

last_failure_classstring

auth, payload, operational (support)

linked_channel_idstring | nullrequired

metadataanyrequired

modestringrequired

namestringrequired

operator_messagestring

Safe message for workspace UI; never raw Meta errors

organization_idstringrequired

phone_numberstring | nullrequired

platformstringrequired

statusstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/channels" \
  -H "Content-Type: application/json" \
  -d '{
  "config": "string",
  "metadata": "string",
  "mode": "single",
  "name": "string",
  "phone": "string",
  "platform": "whatsapp_official"
}'

const response = await fetch("/v1/channels", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "config": "string",
  "metadata": "string",
  "mode": "single",
  "name": "string",
  "phone": "string",
  "platform": "whatsapp_official"
})
});

import requests

response = requests.post(
    "/v1/channels",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "config": "string",
  "metadata": "string",
  "mode": "single",
  "name": "string",
  "phone": "string",
  "platform": "whatsapp_official"
},
)

Response

{
  "config": "string",
  "created_at": "string",
  "health_state": "string",
  "id": "string",
  "is_active": true,
  "last_connected_at": "string",
  "last_error": "string",
  "last_failure_class": "string",
  "linked_channel_id": "string",
  "metadata": "string",
  "mode": "string",
  "name": "string",
  "operator_message": "string",
  "organization_id": "string",
  "phone_number": "string",
  "platform": "string",
  "status": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}