Ver .md

channels.signup_start

Iniciar a conexão de um número de WhatsApp. Cria uma sessão de conexão (válida por 10 minutos, uso único) e devolve o que a janela da Meta precisa: appId, configId e state. Só pela interface.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/channels.signup_start (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: channels:write
  • Grava dados: sim
  • Pela chave de API: não (só pela interface)
  • Ferramenta MCP: não
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channels.signup_start)

Entrada

CampoTipoObrigatórioNota
mode"coexistence" | "new_number"sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "coexistence",
        "new_number"
      ]
    }
  },
  "required": [
    "mode"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channels.signup_start \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode":"coexistence"}'

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "appId": {
      "type": "string"
    },
    "configId": {
      "type": "string"
    },
    "state": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "appId",
    "configId",
    "state"
  ],
  "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).