Entrar

Opt-out: Registrar

POST https://{organization}.myguper.com/api/sender/opt-preference

Registra que o cliente não quer mais receber comunicação. Bloqueia todas as mensagens, exceto o PIN de login.

Mande todos os identificadores que você tiver — person, email e cellphone. É gravada uma linha por identificador e o envio é barrado quando qualquer um deles casa. É isso que faz o opt-out sobreviver a um recadastro: se o cliente se cadastra de novo e ganha um person id novo, o e-mail e o telefone continuam casando. O inverso também vale — se ele troca de e-mail dentro do mesmo cadastro, o alvo person continua casando.

O opt-out vale para a organização do subdomínio: o mesmo e-mail pode estar bloqueado numa organização e continuar recebendo em outra. Nunca atravessa organizações.

Idempotente: registrar o mesmo identificador de novo atualiza a linha em vez de duplicar, e nos dois casos acrescenta uma entrada na trilha de auditoria.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Corpo da requisição

Content-Type: application/json

{
    "person": 184532,                                           // optional
    "email": "cliente@exemplo.com",                             // optional
    "cellphone": "5512345678",                                  // optional
    "countryCallingCode": "52",                                 // optional
    "provider": "<provider>",                                   // optional
    "scope": "<scope>",                                         // optional
    "source": "<source>",                                       // optional
    "actor": "maria@lojista.com",                               // optional
    "detail": "pediu por telefone no SAC"                       // optional
}

Respostas

{
  "type": "optout",
  "provider": "all",
  "scope": "all",
  "targets": [
    { "target_type": "person", "target": "184532" },
    { "target_type": "email",  "target": "cliente@exemplo.com" },
    { "target_type": "phone",  "target": "525512345678" }
  ]
}
Copied to clipboard