groups.groups_import

Importar grupos do WhatsApp para a campanha. Grava até 500 grupos (a ordem dada vira a ordem de position) e enfileira a busca do convite e do acesso do número em cada grupo novo ou sem convite válido. Importar de novo não duplica: os existentes só atualizam nome, descrição e tipo de envio e mantêm posição, contadores e captação. O número precisa estar vinculado à campanha e conectado. jobId é nulo quando não há nada a buscar.

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

Entrada

{
  "$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)$"
    },
    "groups": {
      "minItems": 1,
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "jid": {
            "type": "string",
            "maxLength": 100,
            "pattern": "@g\\.us$"
          },
          "name": {
            "type": "string",
            "maxLength": 200
          },
          "size": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "announce": {
            "type": "boolean"
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2048
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "jid",
          "name"
        ]
      }
    }
  },
  "required": [
    "campaignId",
    "channelId",
    "groups"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.groups_import \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001","channelId":"00000000-0000-4000-8000-000000000001","groups":[{"jid":"[email protected]","name":"Lançamento #001","size":12}]}'

CLI:

node cli/atomiks.mjs groups.groups_import --json '{"campaignId":"00000000-0000-4000-8000-000000000001","channelId":"00000000-0000-4000-8000-000000000001","groups":[{"jid":"[email protected]","name":"Lançamento #001","size":12}]}'

MCP: ferramenta groups_groups_import com a mesma entrada.

Saída

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

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