Update channel

Updates user-managed channel fields for the resolved workspace without changing the underlying provider transport.

PATCH/api/v1/channels/{channelId}

Updates user-managed channel fields for the resolved workspace without changing the underlying provider transport.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?nonEmptyString

a non empty string

Length1 <= length

description?string|null

metadata?|null

Response Body

`application/json`

curl -X PATCH "https://loading/api/v1/channels/{channelId}" \  -H "Content-Type: application/json" \  -d '{    "name": "Support Inbox",    "description": "Primary customer support channel"  }'

{
  "id": "6e0d4e3f-b4fd-4dc1-bddf-cd86d708bdcb",
  "channelConnectionId": "73ac45cb-5e04-4950-a0f9-a9b440ea5cf0",
  "name": "Support Inbox",
  "description": "Receives customer-originated support traffic",
  "kind": "whatsapp",
  "adapter": "custom",
  "externalId": "support-main",
  "metadata": {
    "inbox": "support"
  },
  "lastMessageAt": "2026-03-09T13:00:00.000Z",
  "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": "not_found",
  "message": "The requested resource was not found."
}

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

Update channel

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`