Create channel

Creates a channel that can later be connected to an adapter or used directly for API-driven traffic.

POST/api/v1/experimental/channels

Creates a channel that can later be connected to an adapter or used directly for API-driven traffic.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

a non empty string

Length1 <= length

description?|

kind*string

High-level transport represented by the channel.

adapter?string

a non empty string

Length1 <= length

externalId?|

metadata?|

Response Body

`application/json`

curl -X POST "https://loading/api/v1/experimental/channels" \  -H "Content-Type: application/json" \  -d '{    "name": "Support Inbox",    "description": "Receives customer-originated support traffic",    "kind": "whatsapp",    "adapter": "custom",    "externalId": "support-main",    "metadata": {      "inbox": "support"    }  }'

{
  "id": "6e0d4e3f-b4fd-4dc1-bddf-cd86d708bdcb",
  "name": "Support Inbox",
  "description": "Receives customer-originated support traffic",
  "kind": "whatsapp",
  "adapter": "custom",
  "externalId": "support-main",
  "metadata": {
    "inbox": "support"
  },
  "createdAt": "2026-03-09T12:55:00.000Z",
  "updatedAt": "2026-03-09T13:00:00.000Z"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have the required permission.",
  "details": {
    "requiredPermission": "resource.action"
  }
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Create channel

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`