message_history.options

Opções dos filtros Broadcast e Automação. Lista para os filtros do Histórico de envio: kind: broadcast traz os envios em massa (nome do modelo ou começo do texto), kind: workflow as automações, com id e name. search filtra pelo nome. Até 100 itens, os mais recentes.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "broadcast",
        "workflow"
      ]
    },
    "search": {
      "type": "string",
      "maxLength": 100
    }
  },
  "required": [
    "kind"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/message_history.options \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"workflow"}'

CLI:

node cli/atomiks.mjs message_history.options --json '{"kind":"workflow"}'

MCP: ferramenta message_history_options com a mesma entrada.

Saída

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

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