Sign in

Opt-out: Revoke

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

Puts a customer back on the list — they start receiving again.

Revokes only the identifiers you send. If the opt-out was registered with e-mail and phone and you send just the e-mail, the phone stays blocked. That is deliberate: partial revocation should never be a side effect.

The current state is deleted, but the audit trail is not. The revocation is appended to it, so the history of what the customer asked for is never lost.

Try-it values populated from environment ACME (Demo)


Authentication

Token

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

Headers

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.

Request body

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": "<actor>",                                         // optional
    "detail": "<detail>"                                        // optional
}

Responses

{
  "type": "optin",
  "targets": [
    { "target_type": "person", "target": "184532" },
    { "target_type": "email",  "target": "cliente@exemplo.com" }
  ],
  "removed": 2
}
Copied to clipboard