AtomiksAPI
Ver .md

channel_connections.display_name_update

Pedir a troca do nome de exibição de um número de WhatsApp. Envia o novo nome à Meta (new_display_name). O nome passa por revisão e só vale depois da aprovação; até lá o nome atual continua. Devolve pendingReview. Número em coexistência: a Meta revisa à mão.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/channel_connections.display_name_update (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: channels:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: channel_connections_display_name_update
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channel_connections.display_name_update)

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
namestringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 512
    }
  },
  "required": [
    "channelId",
    "name"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channel_connections.display_name_update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"00000000-0000-0000-0000-000000000000","name":"Minha Loja"}'

CLI:

node cli/atomiks.mjs channel_connections.display_name_update --json '{"channelId":"00000000-0000-0000-0000-000000000000","name":"Minha Loja"}'

MCP: ferramenta channel_connections_display_name_update com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "pendingReview": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "pendingReview"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).

channel_connections.display_name_update · Atomiks API