Ver .md

groups.groups_create

Criar grupos numerados em lote. Enfileira a criação de count (1 a 100) grupos chamados "<baseName> #NNN" (3 dígitos). startNumber padrão = maior número já usado com essa base na campanha (inclusive em jobs ainda na fila) + 1. A criação roda pelo governador, um por vez; o número precisa estar vinculado à campanha. adminPhones (1 a 5, só dígitos com DDI, 12 a 13) é obrigatório: a Evolution não cria grupo sem participante, então os números da equipe do lançador entram na criação e viram admins. onlyAdminsSend (padrão ligado) deixa só admins enviarem. pictureUrl precisa ser https.

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

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
channelIdstring (uuid)sim
baseNamestringsim
startNumberintegernão
countintegersim
descriptionstringnão
pictureUrlstringnão
onlyAdminsSendbooleannãopadrão true
adminPhonesstring[]sim
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)$"
    },
    "channelId": {
      "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)$"
    },
    "baseName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    },
    "startNumber": {
      "type": "integer",
      "minimum": 1,
      "maximum": 999
    },
    "count": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "description": {
      "type": "string",
      "maxLength": 512
    },
    "pictureUrl": {
      "type": "string",
      "maxLength": 2000
    },
    "onlyAdminsSend": {
      "default": true,
      "type": "boolean"
    },
    "adminPhones": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^\\d{12,13}$"
      }
    }
  },
  "required": [
    "campaignId",
    "channelId",
    "baseName",
    "count",
    "adminPhones"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.groups_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001","channelId":"00000000-0000-4000-8000-000000000001","baseName":"Lançamento","count":3,"onlyAdminsSend":true,"adminPhones":["5511999990000"]}'

CLI:

node cli/atomiks.mjs groups.groups_create --json '{"campaignId":"00000000-0000-4000-8000-000000000001","channelId":"00000000-0000-4000-8000-000000000001","baseName":"Lançamento","count":3,"onlyAdminsSend":true,"adminPhones":["5511999990000"]}'

MCP: ferramenta groups_groups_create com a mesma entrada.

Saída

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

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