Skip to content

Area: Developers

GET

Open a subscribe (confirmation) link

Path
/subscribe/oneclick/{payload}
Auth
None · a public or signed link
GET
/subscribe/oneclick/{payload}
curl --request GET \
--url https://releva.ai/api/v0/subscribe/oneclick/example

The page a shopper reaches from the {{subscribeLink}} merge tag, typically in a double opt-in email sent by a flow triggered by the subscribeRequest event. Releva mints the payload. Subscribes the email in the payload and adds the subscriptions it carries (from the original request), then returns an HTML confirmation page that redirects to your shop after 10 seconds. English only.

payload
required
string

URL-encoded base64 JSON minted by Releva (encrypted secret, email or phone number, redirect URL). Never build it yourself.

Subscribed. HTML page titled “Subscribe Successful”.

Media typetext/html
string

Example

<h4>Email address "maria@example.com" has been successfully subscribed.</h4>

Invalid or tampered link. HTML page titled “Subscribe Failed”.

Media typetext/html
string

Example

<h4>The subscribe link you followed seems to be invalid.</h4>

The subscribe could not be saved. HTML page.

Media typetext/html
string

Example

<h4>We encountered an internal error and were unable to subscribe you.</h4>