Ver .md

groups.link_create

Criar link extra de captação. Cria um link extra para a campanha (/g/<código>, código único entre campanhas e links). rotationPolicy nulo usa a política da campanha. Depois associe grupos ao link com groups.groups_update_bulk (linkId).

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

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
namestringsim
rotationPolicy"sequential" | "weighted" | "round_robin" | 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)$"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "rotationPolicy": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "sequential",
            "weighted",
            "round_robin"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "campaignId",
    "name"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta groups_link_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": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "rotationPolicy": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "sequential",
            "weighted",
            "round_robin"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "groups": {
      "type": "number"
    },
    "clicks7d": {
      "type": "number"
    }
  },
  "required": [
    "id",
    "name",
    "code",
    "url",
    "rotationPolicy",
    "groups",
    "clicks7d"
  ],
  "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).