Ver .md

groups.rotation_now

Ver quem recebe agora na rotação. Grupo que a política escolheria agora e o seguinte (sem reservar vaga), para o link principal (linkId nulo) ou um link extra, mais a política em uso, as vagas livres e quantos grupos ainda têm vaga.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/groups.rotation_now (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_rotation_now
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId groups.rotation_now)

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
linkIdstring (uuid) | nullnão
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)$"
    },
    "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": [
    "campaignId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs groups.rotation_now --json '{"campaignId":"00000000-0000-4000-8000-000000000001"}'

MCP: ferramenta groups_rotation_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": {
    "groupId": {
      "type": [
        "string",
        "null"
      ]
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "memberCount": {
      "type": [
        "number",
        "null"
      ]
    },
    "reservedCount": {
      "type": [
        "number",
        "null"
      ]
    },
    "capacity": {
      "type": [
        "number",
        "null"
      ]
    },
    "nextGroupId": {
      "type": [
        "string",
        "null"
      ]
    },
    "nextName": {
      "type": [
        "string",
        "null"
      ]
    },
    "policy": {
      "type": "string",
      "enum": [
        "sequential",
        "weighted",
        "round_robin"
      ]
    },
    "freeSeats": {
      "type": "number"
    },
    "groupsWithSeats": {
      "type": "number"
    }
  },
  "required": [
    "groupId",
    "name",
    "memberCount",
    "reservedCount",
    "capacity",
    "nextGroupId",
    "nextName",
    "policy",
    "freeSeats",
    "groupsWithSeats"
  ],
  "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).