Entrar

Opt-out: Histórico

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

Trilha append-only de tudo que já foi registrado ou revogado para um cliente, mais recentes primeiro.

Separada do estado atual de propósito: a linha de estado é sobrescrita a cada mudança, enquanto esta nunca é reescrita nem apagada. É ela que prova quem pediu para parar, quando e por qual canal — incluindo opt-outs que depois foram revogados e já não aparecem em Consultar.

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
q[column][operator] string Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table.
o[column] string Sort by column. Direction: `ASC`, `DESC`, `1` or `0`.
e integer How many entries, capped at 500.
padrão: 100
p integer Page number (≥ 1).
padrão: 1
person integer At least one of `person`, `email` or `cellphone` is required.
email string
cellphone string Digits only, without the country code.
countryCallingCode string

Respostas

{
  "targets": [
    { "target_type": "email", "target": "cliente@exemplo.com" }
  ],
  "history": [
    {
      "target_type": "email", "target": "cliente@exemplo.com",
      "provider": "all", "scope": "all", "type": "optin",
      "source": "admin", "actor": "maria@lojista.com", "person": 184532,
      "detail": "voltou atras", "createdAt": "2026-09-02 15:40:11"
    },
    {
      "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"
    }
  ]
}

Relacionados

Copied to clipboard