Entrar

Opt-out: Consultar

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

Responde a pergunta que o suporte realmente faz: uma mensagem para este cliente seria barrada?

Passe qualquer combinação de identificadores. A consulta usa o mesmo casamento que o caminho de envio usa, então optedOut é o que vai acontecer de fato — não uma aproximação. O matchedBy diz qual identificador causou o bloqueio, e isso importa: barrado por e-mail e barrado por pessoa levam a conversas diferentes.

Escopado à organização do subdomínio.

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.

Parâmetros de query

Name Type Description
person integer At least one of `person`, `email` or `cellphone` is required.
email string
cellphone string Digits only, without the country code.
countryCallingCode string Needed for the phone to match what delivery looks up.
provider string Channel to test. A channel-specific opt-out only blocks that channel.
padrão: all

Respostas

{
  "targets": [
    { "target_type": "person", "target": "184532" },
    { "target_type": "email",  "target": "cliente@exemplo.com" }
  ],
  "optedOut": true,
  "matchedBy": {
    "target_type": "email",
    "target": "cliente@exemplo.com",
    "provider": "all",
    "scope": "all",
    "source": "admin",
    "createdAt": "2026-09-02 10:14:03"
  },
  "preferences": [
    {
      "target_type": "email", "target": "cliente@exemplo.com",
      "provider": "all", "scope": "all", "type": "optout",
      "source": "admin", "actor": "maria@lojista.com", "person": 184532,
      "detail": "pediu por telefone no SAC",
      "createdAt": "2026-09-02 10:14:03", "updatedAt": "2026-09-02 10:14:03"
    }
  ]
}
Copied to clipboard