Ver .md

groups.message_preview

Prévia da variação de texto. Sorteia 3 variações do texto com {a|b|c} e diz se a sintaxe é válida (valid). Texto inválido devolve samples vazio.

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

Entrada

CampoTipoObrigatórioNota
bodystringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "body"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.message_preview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"{Oi|Olá}, tudo bem?"}'

CLI:

node cli/atomiks.mjs groups.message_preview --json '{"body":"{Oi|Olá}, tudo bem?"}'

MCP: ferramenta groups_message_preview com a mesma entrada.

Saída

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

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