AtomiksAPI
Ver .md

groups.send_now

Enviar uma mensagem agora para os grupos. Enfileira o envio da mensagem para o alvo ({all: true}, {folderId}, {linkId} com null = link principal, ou {groupIds}), resolvido na hora, só grupos vivos com número. O conteúdo fica congelado no job. speed: slow 6 s, normal 2 s, fast 1,25 s entre grupos do mesmo número. Cria um job por número; total = grupos (0 = nada a enviar).

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

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
messageIdstring (uuid)sim
targetobjectsim
speed"slow" | "normal" | "fast"nãopadrão "normal"
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "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)$"
    },
    "messageId": {
      "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)$"
    },
    "target": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "all": {
              "type": "boolean",
              "const": true
            }
          },
          "required": [
            "all"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "folderId": {
              "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)$"
            }
          },
          "required": [
            "folderId"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "linkId": {
              "anyOf": [
                {
                  "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)$"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "linkId"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "groupIds": {
              "minItems": 1,
              "maxItems": 2000,
              "type": "array",
              "items": {
                "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)$"
              }
            }
          },
          "required": [
            "groupIds"
          ],
          "additionalProperties": false
        }
      ]
    },
    "speed": {
      "default": "normal",
      "type": "string",
      "enum": [
        "slow",
        "normal",
        "fast"
      ]
    }
  },
  "required": [
    "campaignId",
    "messageId",
    "target"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.send_now \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001","messageId":"00000000-0000-4000-8000-000000000001","target":{"all":true},"speed":"normal"}'

CLI:

node cli/atomiks.mjs groups.send_now --json '{"campaignId":"00000000-0000-4000-8000-000000000001","messageId":"00000000-0000-4000-8000-000000000001","target":{"all":true},"speed":"normal"}'

MCP: ferramenta groups_send_now com a mesma entrada.

Saída

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

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