groups.number_profile_set

Definir o perfil de segurança de um número de Grupos. Grava o perfil do número; vale já no próximo item de um disparo em andamento. Em custom, customLimits traz por ação {perHour, perDay, minGapMs}; o servidor recusa perHour ou perDay acima de 2 vezes o valor da Leve, minGapMs abaixo de 500 e qualquer valor acima de 0 em add_participant. Ações não informadas usam os valores da Leve. Em outros perfis customLimits é ignorado e os limites personalizados já gravados ficam guardados.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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)$"
    },
    "profile": {
      "type": "string",
      "enum": [
        "auto",
        "maximum",
        "moderate",
        "light",
        "custom"
      ]
    },
    "customLimits": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "object",
        "properties": {
          "perHour": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "perDay": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "minGapMs": {
            "type": "integer",
            "minimum": 0,
            "maximum": 3600000
          }
        },
        "required": [
          "perHour",
          "perDay",
          "minGapMs"
        ]
      }
    }
  },
  "required": [
    "channelId",
    "profile"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs groups.number_profile_set --json '{"channelId":"00000000-0000-4000-8000-000000000001","profile":"moderate"}'

MCP: ferramenta groups_number_profile_set com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string"
    },
    "profile": {
      "type": "string",
      "enum": [
        "auto",
        "maximum",
        "moderate",
        "light",
        "custom"
      ]
    },
    "customLimits": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "object",
        "properties": {
          "perHour": {
            "type": "number"
          },
          "perDay": {
            "type": "number"
          },
          "minGapMs": {
            "type": "number"
          }
        },
        "required": [
          "perHour",
          "perDay",
          "minGapMs"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "channelId",
    "profile"
  ],
  "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).