put
https://api.inngage.com.br/v4/unsubscription/
Cancela a inscrição de um subscriber em um canal específico (ou em todos), alterando optIn/cloudStatus dos canais de mensageria e/ou devices no MongoDB.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Comportamento por canal
channel | Alvo | Efeito da action |
|---|---|---|
email / whatsapp / sms / rcs | elemento correspondente do array channels (por type: email=5, sms=2, whatsapp=3, rcs=9) | optOut → optIn: false · cloudOff → cloudStatus: false · fullUnsubscribe → ambos false; grava invalidReason se enviado |
push | devices com platformId ∈ [1, 2, 6] | mesmas actions aplicadas nos devices + lastUpdate |
webpush | devices com platformId ∉ [1, 2, 6] | idem |
all | todos os canais e todos os devices | seta cloudStatus: false em tudo (dois updates sequenciais) |
Sempre atualiza updatedIn. Sem side effects (não há Pub/Sub, Slack ou eventos).
Respostas
Shape sempre { "message": "<string>" }.
| Status | Mensagem | Condição |
|---|---|---|
| 200 | Subscriber updated successfully | documento modificado |
| 200 | Subscriber was already updated | encontrado, mas nada mudou |
| 404 | Subscriber not found | filtro não casou |
| 400 | mensagem de validação Zod ou ValidationError | |
| 401 | app_token inválido ou app desativado | |
| 500 | Internal server error (ou mensagem de DomainError) |
Exemplos
{
"app_token": "a1b2c3d4e5f6g7h8",
"identifier": "[email protected]",
"channel": "email",
"action": "optOut",
"invalidReason": "hard_bounce"
}{ "appToken": "a1b2c3d4e5f6g7h8", "registration": "fcm-token-xyz", "channel": "all" }