groups.welcome_settings

Boas-vindas da campanha. Sem campos além de campaignId, lê a configuração (qualquer membro). Com enabled, windowMinutes (1 a 60, agrupa quem entra) ou hours (HH:MM-HH:MM no fuso da campanha), grava (administrador, escopo marketing:write). messageId é a mensagem marcada como boas-vindas; sem ela, ligar não envia nada.

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

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)$"
    },
    "enabled": {
      "type": "boolean"
    },
    "windowMinutes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 60
    },
    "hours": {
      "type": "string",
      "pattern": "^([01]\\d|2[0-3]):[0-5]\\d-([01]\\d|2[0-3]):[0-5]\\d$"
    }
  },
  "required": [
    "campaignId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.welcome_settings \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-0000-0000-000000000000","enabled":true,"windowMinutes":5,"hours":"08:00-22:00"}'

CLI:

node cli/atomiks.mjs groups.welcome_settings --json '{"campaignId":"00000000-0000-0000-0000-000000000000","enabled":true,"windowMinutes":5,"hours":"08:00-22:00"}'

MCP: ferramenta groups_welcome_settings com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "windowMinutes": {
      "type": "number"
    },
    "hours": {
      "type": "string"
    },
    "messageId": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "campaignId",
    "enabled",
    "windowMinutes",
    "hours",
    "messageId"
  ],
  "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).