notifications.prefs_set

Alterar uma preferência de notificação. Liga ou desliga um canal (inApp ou mobilePush) para um tipo de aviso, ou para todos (kind = ALL). Tipos: PURCHASE_COMPLETED, PIX_EXPIRED, TRIAL_STARTED, PAYMENT_GENERATED, OPPORTUNITY_CREATED, OPPORTUNITY_WON, OPPORTUNITY_LOST, OPPORTUNITY_ASSIGNED, OPPORTUNITY_SLA_BREACHED, FLOWS_PAUSED_CHANNEL_DOWN, FLOWS_RESUMED, FLOW_RESUME_REQUIRED, FLOW_RUN_FAILED, FLOW_RUN_AT_RISK, DOMAIN_CONNECTED, DOMAIN_MIGRATION_NEEDED, DOMAIN_SETUP_PENDING, DOMAIN_DISCONNECTED, SKILLS_UPDATE_AVAILABLE, CREDITS_LOW, GROUPS_ALERT, CHANNEL_ACCOUNT_LIVECHAT_DISABLED, EMAIL_INBOX_SYNC_FAILING, EMAIL_INBOX_SYNC_RECOVERED, WHATSAPP_NUMBER_UNAVAILABLE, WHATSAPP_NUMBER_RESTORED, CHANNEL_RECONNECT_REQUIRED, CHANNEL_DISCONNECTED, WHATSAPP_COEXISTENCE_DISCONNECTED, WHATSAPP_COEXISTENCE_INACTIVITY_WARNING, NEW_MESSAGE, CONVERSATION_ASSIGNED, SCHEDULED_MESSAGE_FAILED, MARKETPLACE_TESTIMONIAL_REQUESTED, MARKETPLACE_TESTIMONIAL_SUBMITTED, TASK_ASSIGNED. Canal que o tipo não usa responde invalid_input. Devolve a matriz inteira.

• Endpoint: POST https://app.atomiks.com.br/api/v1/notifications.prefs_set (corpo JSON)
• Quem pode chamar: qualquer usuário autenticado
• Escopo da chave: nenhum (qualquer chave serve)
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: notifications_prefs_set
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId notifications.prefs_set)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "ALL",
        "PURCHASE_COMPLETED",
        "PIX_EXPIRED",
        "TRIAL_STARTED",
        "PAYMENT_GENERATED",
        "OPPORTUNITY_CREATED",
        "OPPORTUNITY_WON",
        "OPPORTUNITY_LOST",
        "OPPORTUNITY_ASSIGNED",
        "OPPORTUNITY_SLA_BREACHED",
        "FLOWS_PAUSED_CHANNEL_DOWN",
        "FLOWS_RESUMED",
        "FLOW_RESUME_REQUIRED",
        "FLOW_RUN_FAILED",
        "FLOW_RUN_AT_RISK",
        "DOMAIN_CONNECTED",
        "DOMAIN_MIGRATION_NEEDED",
        "DOMAIN_SETUP_PENDING",
        "DOMAIN_DISCONNECTED",
        "SKILLS_UPDATE_AVAILABLE",
        "CREDITS_LOW",
        "GROUPS_ALERT",
        "CHANNEL_ACCOUNT_LIVECHAT_DISABLED",
        "EMAIL_INBOX_SYNC_FAILING",
        "EMAIL_INBOX_SYNC_RECOVERED",
        "WHATSAPP_NUMBER_UNAVAILABLE",
        "WHATSAPP_NUMBER_RESTORED",
        "CHANNEL_RECONNECT_REQUIRED",
        "CHANNEL_DISCONNECTED",
        "WHATSAPP_COEXISTENCE_DISCONNECTED",
        "WHATSAPP_COEXISTENCE_INACTIVITY_WARNING",
        "NEW_MESSAGE",
        "CONVERSATION_ASSIGNED",
        "SCHEDULED_MESSAGE_FAILED",
        "MARKETPLACE_TESTIMONIAL_REQUESTED",
        "MARKETPLACE_TESTIMONIAL_SUBMITTED",
        "TASK_ASSIGNED"
      ]
    },
    "channel": {
      "type": "string",
      "enum": [
        "inApp",
        "mobilePush"
      ]
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "kind",
    "channel",
    "enabled"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/notifications.prefs_set \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"PURCHASE_COMPLETED","channel":"mobilePush","enabled":false}'

CLI:

node cli/atomiks.mjs notifications.prefs_set --json '{"kind":"PURCHASE_COMPLETED","channel":"mobilePush","enabled":false}'

MCP: ferramenta notifications_prefs_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": {
    "general": {
      "type": "object",
      "properties": {
        "inApp": {
          "type": "boolean"
        },
        "mobilePush": {
          "type": "boolean"
        }
      },
      "required": [
        "inApp",
        "mobilePush"
      ],
      "additionalProperties": false
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "kinds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "inApp": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "mobilePush": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                }
              },
              "required": [
                "kind",
                "label",
                "description",
                "inApp",
                "mobilePush"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "key",
          "title",
          "kinds"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "general",
    "categories"
  ],
  "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).