inbox.start_candidates

Contatos e números para iniciar conversa. Até 50 contatos com telefone que o membro pode ver (busca por nome ou telefone a partir de 2 caracteres; contatos ainda sem conversa entram) e os números conectados que ele pode usar.

• Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.start_candidates (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: messages:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: inbox_start_candidates
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.start_candidates)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 80
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.start_candidates \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"Maria"}'

CLI:

node cli/atomiks.mjs inbox.start_candidates --json '{"q":"Maria"}'

MCP: ferramenta inbox_start_candidates com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "phone"
        ],
        "additionalProperties": false
      }
    },
    "channels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "phone"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "contacts",
    "channels"
  ],
  "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).