GET
Open an unsubscribe link
- Path
/unsubscribe/oneclick/{payload}- Auth
- None · a public or signed link
GET
/unsubscribe/oneclick/{payload}
const url = 'https://releva.ai/api/v0/unsubscribe/oneclick/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://releva.ai/api/v0/unsubscribe/oneclick/exampleThe page a shopper reaches from the {{unsubscribeLink}} merge tag when subscription management is
Internal. Releva mints the payload; you do not build it. Unsubscribes the email or phone number in the
payload (same effect as POST /unsubscribe) and returns an HTML confirmation page that redirects to
your shop after 10 seconds. Translated for bg and el, English otherwise.
Served from your shop’s click-tracking host.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”payload
required
string
URL-encoded base64 JSON minted by Releva (encrypted secret, email or phone number, redirect URL). Never build it yourself.
Responses
Section titled “Responses”Unsubscribed. HTML page titled “Unsubscribe Successful”.
Media typetext/html
string
Example
<h4>Email address "maria@example.com" has been successfully unsubscribed.</h4>Invalid or tampered link. HTML page titled “Unsubscribe Failed”.
Media typetext/html
string
Example
<h4>The unsubscribe link you followed seems to be invalid.</h4>The unsubscribe could not be saved. HTML page.
Media typetext/html
string
Example
<h4>We encountered an internal error and were unable to unsubscribe you.</h4>