Skip to content

Area: Developers

All endpoints

Every public endpoint of the Releva API, in the order of the API sidebar. Select an endpoint for its parameters, request, response and a working example. Select a group for the overview that explains when to use its endpoints. The table is generated from the API contract, so it always matches the endpoint pages.

MethodPathEndpointGroup
POST/productsCreate or update productsProduct catalog
POST/products/availabilityUpdate product availabilityProduct catalog
POST/products/syncStart a full catalog syncProduct catalog
DELETE/products/{docId}Delete a productProduct catalog
GET/eventsList eventsEvents
POST/eventsSend custom eventsEvents
POST/searchSend search eventsEvents
POST/cartsReport paid ordersOrders and refunds
POST/refundsReport refundsOrders and refunds
GET/loyalty-linkGet a profile's loyalty page linkProfiles
GET/profilesGet a profileProfiles
POST/profilesCreate or update profilesProfiles
DELETE/profilesDelete a profileProfiles
POST/profiles/exportsExport a profile's dataProfiles
POST/registerRecord a registrationProfiles
POST/subscribers/syncStart a subscriber syncProfiles
POST/companiesCreate or update companiesCompanies (B2B)
DELETE/companies/{companyId}Delete a companyCompanies (B2B)
POST/rolesLink profiles to companiesCompanies (B2B)
DELETE/roles/{companyId}/{emailOrPhone}Remove a profile from a companyCompanies (B2B)
POST/subscribeSubscribe a profile or update its subscriptionsConsent and subscriptions
POST/unsubscribeUnsubscribe a profileConsent and subscriptions
GET/unsubscribe/oneclick/{payload}Open an unsubscribe linkConsent and subscriptions
POST/unsubscribe/oneclick/{payload}One-click unsubscribe (RFC 8058)Consent and subscriptions
GET/subscribe/oneclick/{payload}Open a subscribe (confirmation) linkConsent and subscriptions
POST/subscribe/requestSubscribe from the browser (double opt-in aware)Consent and subscriptions
POST/subscribe/checkCheck whether an email has a consent historyConsent and subscriptions
POST/campaigns/{id}/runsRun a webhook-triggered campaignCampaign runs
GET/webhooks/eventsRecord a webhook open or clickWebhooks
GET/webhooks/events/{accessToken}Record a webhook open or click (token in the path)Webhooks
POST/pushGet the product blocks for a page (access token in the header)SDK calls
POST/impressions/{accessToken}Report that product blocks or banner blocks were seenSDK calls
POST/impressionsReport that blocks were seen (access token in the header)SDK calls
POST/push/events/{accessToken}Report a banner, story or page engagement eventSDK calls
POST/push/eventsReport a banner, story or page engagement event (access token in the header)SDK calls
POST/orders/status-reference/{accessToken}Look up an order for the order status pageSDK calls
POST/orders/status-referenceLook up an order for the order status page (access token in the header)SDK calls
POST/push/{accessToken}Send a page view from the storefront (tracking snippet)SDK calls
POST/appPush/tokensRegister a mobile app push tokenPush notifications
POST/pushSubscriptions/{accessToken}Register a browser push subscriptionPush notifications
GET/inbox/messagesList inbox messagesApp inbox
GET/inbox/unread-countCount unread inbox messagesApp inbox
POST/inbox/messages/{messageId}/readMark a message as readApp inbox
POST/inbox/messages/read-allMark all messages as readApp inbox
DELETE/inbox/messages/{messageId}Delete a messageApp inbox
POST/inbox/messages/{messageId}/actionReport a tap on a messageApp inbox
POST/searchAsYouType/{accessToken}Search products as the shopper typesSearch as you type
GET/surveys/{token}Open a surveySurveys and NPS
POST/surveys/{token}/submissionsSubmit survey answersSurveys and NPS
POST/nps/{token}/submissionsSubmit an NPS answerSurveys and NPS
PUT/partners/domainsUpdate, pause or resume a shopPartner API
POST/partners/domainsProvision a shopPartner API
GET/partners/subscriptionsList Releva plansPartner API
POST/partners/domains/trialDaysGet remaining trial daysPartner API
POST/partners/domains/subscriptions/confirmConfirm a plan and billing periodPartner API
POST/partners/domains/uninstallReport that the app was uninstalledPartner API
POST/partners/domains/usageRecords/confirmConfirm a usage chargePartner API
POST/partners/domains/profilesCreate or update profiles for a shopPartner API
DELETE/partners/domains/profilesDelete a profile of a shopPartner API
GET/users/partnerSignin/{token}/{payload}Single sign-on link into the Releva adminPartner API
  • API referenceAPI overview

    Open the full reference of every endpoint, grouped by area, with its parameters and responses.

  • API referenceEndpoints the Releva SDKs call

    See the storefront and app endpoints the SDKs call, if you build your own client.