set_notification_preference
Guardar preferência de canal; não configura nem comprova entrega de notificações.
Preferências de avisos · Editar ou configurar · Escrita local
Efeito da chamada
Esta ferramenta altera dados locais da instalação. Confirme a ação e o espaço com o proprietário antes de enviar confirmed: true e uma chave de idempotência. Ela não altera registros nem executa pagamentos no banco.
Parâmetros
| Campo | Obrigatório | Tipo | Uso |
|---|---|---|---|
confirmed | Sim | true | Deve ser true somente depois da confirmação explícita do proprietário. |
idempotency_key | Sim | texto | Chave única para esta solicitação. Reutilize apenas para repetir exatamente a mesma operação. |
spaceId | Sim | texto | Espaço da instalação. Consulte get_spaces; o espaço inicial é personal. |
channel | Sim | "email" / "push" | Canal da preferência de aviso; não configura um serviço de entrega. |
enabled | Sim | booleano | Define se a regra ou preferência está habilitada. |
event | Sim | texto | Evento da preferência de aviso. Guardar a preferência não agenda uma entrega. |
Filtros compostos e limites estão no schema completo. Campos não listados são recusados.
Exemplo de chamada
Substitua os IDs fictícios pelos da sua instalação, obtidos nas consultas indicadas nos parâmetros.
{
"name": "set_notification_preference",
"arguments": {
"confirmed": true,
"idempotency_key": "docs:set_notification_preference:01",
"spaceId": "personal",
"channel": "email",
"enabled": true,
"event": "event-exemplo"
}
}
Interpretar o resultado
Confira o resultado da chamada antes de dar a alteração como concluída. Se a rede falhar, repita somente os mesmos argumentos com a mesma chave. Atualize a leitura se a revisão estiver obsoleta antes de confirmar outra operação.
O registro desta ferramenta não declara outputSchema. Consulte as regras de resposta no guia de contratos.
Contrato completo
Ver JSON Schema de entrada
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirmed": {
"type": "boolean",
"const": true
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"spaceId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"channel": {
"type": "string",
"enum": [
"email",
"push"
]
},
"enabled": {
"type": "boolean"
},
"event": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"confirmed",
"idempotency_key",
"spaceId",
"channel",
"enabled",
"event"
],
"additionalProperties": false
}
Voltar para Preferências de avisos · Confirmações e contratos