get
https://production-api.shoutaboutus.com/api/v1/campaign/email/unsubscribe/
Decodes the tamper-proof, server-encrypted UnsubscribeToken from a campaign-email unsubscribe link and returns the masked recipient address plus whether they are already on the suppression list. Render-only — no state change. A generic the endpoint returns 404 for any invalid/expired token so the response never reveals whether a specific address or token is valid.
Path params
| Parameter | Type | Required | Notes |
|---|---|---|---|
unsubscribeToken | string | Required | Identifier for the record you are targeting. |
Auth
- Public — no bearer token (unauthenticated
campaigngroup; item markednoauth). Reached from the unsubscribe link in customizable emails.
Rate limit
- 30 requests/min per IP (public).
Behaviour
- 200
{ status: "success", data: { email_masked, already_unsubscribed } }.email_maskedshows only the first local-part character (e.g.j***@example.com);already_unsubscribedis true when the address is on theblacklistssuppression list. - 404 (
notFoundResponse) "Invalid or expired unsubscribe link." for any bad/expired token.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
