Skip to content

Area: Developers

Consent API overview

Used byCustom website, JavaScript SDK, Partner platforms, Mobile SDKs

The consent API records who may receive marketing messages from your shop. All calls live under https://releva.ai/api/v0. Server calls take your secret key; browser calls take the access token (see Find your Access Token and Secret Key).

Not sure which call you need? Start with Choose a consent call.

Page Endpoint Key
Subscribe a customer from your server POST /subscribe Secret key
Subscribe a customer from the browser POST /subscribe/request, Releva.requestSubscribe Access token
Set up double opt-in POST /subscribe/request, then GET /subscribe/oneclick/{payload} Access token
Unsubscribe a customer with the API POST /unsubscribe Secret key
Unsubscribe links and one-click unsubscribe GET and POST /unsubscribe/oneclick/{payload}, the subscription preferences page None (the link carries it)
Check an email’s consent history POST /subscribe/check, Releva.checkSubscribed Access token

For what subscribed, unsubscribed and subscriptions mean on a profile, read How consent works in Releva.