Entrar

Opt-out: Registrar

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

Registra que el cliente ya no quiere recibir comunicación. Bloquea todos los mensajes, excepto el PIN de inicio de sesión.

Envíe todos los identificadores que tenga — person, email y cellphone. Se guarda una fila por identificador y el envío se bloquea cuando cualquiera de ellos coincide. Eso es lo que hace que el opt-out sobreviva a un nuevo registro: si el cliente se registra otra vez y obtiene un person id nuevo, el correo y el teléfono siguen coincidiendo. Lo inverso también aplica — si cambia de correo dentro del mismo registro, el objetivo person sigue coincidiendo.

El opt-out aplica a la organización del subdominio: el mismo correo puede estar bloqueado en una organización y seguir recibiendo en otra. Nunca cruza organizaciones.

Idempotente: registrar el mismo identificador de nuevo actualiza la fila en vez de duplicarla, y en ambos casos agrega una entrada a la traza de auditoría.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

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

Encabezados

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.

Cuerpo de la petición

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
}

Respuestas

{
  "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