DOM360
Canais

Alterar um canal

PATCH
/channels/{channel_id}

Altera o nome, o agente, a identidade, a credencial, a configuração ou o interruptor. Campo ausente fica como está; null apaga onde apagar é permitido: agent_id desliga o agente, credential revoga o token guardado e external_identity apaga o número do WhatsApp — a caixa do Chatwoot não fica vazia, porque é ela que roteia. A configuração substitui a anterior inteira. O tipo não muda e o estado não é do operador.

Autorização

bearer channels:write
AutorizaçãoBearer <token>

Credencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.

Em: header

Escopo: channels:write

Parâmetros de caminho

channel_id*string

Id do canal

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

O corpo de PATCH /channels/{channel_id}. Ausente mantém; null apaga onde apagar é permitido, e é recusado (422, nomeando o campo) onde não é — o nome, a configuração e o interruptor. O tipo não muda, e o estado não é do operador (é observado pelo transporte; enabled é o interruptor).

Corpo da resposta

application/json

application/json

curl -X PATCH "https://example.com/channels/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",  "campaign_eligibility": {    "eligible": true,    "reason": "string"  },  "capabilities": {    "delivery": "none",    "initiation": "never",    "owner": "external",    "requires_pairing": true,    "session_window_seconds": 0  },  "created_at": "2019-08-24T14:15:22Z",  "enabled": true,  "external_identity": "string",  "has_credential": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "is_serving": true,  "last_status_at": "2019-08-24T14:15:22Z",  "name": "string",  "status": "disconnected",  "status_detail": "string",  "status_label": "string",  "tenant_id": 0,  "type_label": "string",  "updated_at": "2019-08-24T14:15:22Z",  "config": {    "account_id": 0,    "auto_respond": true,    "base_url": "string",    "transcribe_audio": true  },  "type": "chatwoot"}