# All endpoints

> Every public Releva API endpoint in one table, with its method, path, name and group, generated from the API contract. Filter the table to find an endpoint.

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](https://releva.ai/documentation/openapi.yaml), so it always matches the endpoint pages.

| Method | Path                                      | Endpoint                                                                                                                                                 | Group                                                                       |
| ------ | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| POST   | `/products`                               | [Create or update products](https://releva.ai/documentation/reference/api/operations/upsertproducts/)                                                                     | [Product catalog](https://releva.ai/documentation/reference/catalog/overview/)               |
| POST   | `/products/availability`                  | [Update product availability](https://releva.ai/documentation/reference/api/operations/updateproductsavailability/)                                                       | [Product catalog](https://releva.ai/documentation/reference/catalog/overview/)               |
| POST   | `/products/sync`                          | [Start a full catalog sync](https://releva.ai/documentation/reference/api/operations/triggerproductsync/)                                                                 | [Product catalog](https://releva.ai/documentation/reference/catalog/overview/)               |
| DELETE | `/products/{docId}`                       | [Delete a product](https://releva.ai/documentation/reference/api/operations/deleteproduct/)                                                                               | [Product catalog](https://releva.ai/documentation/reference/catalog/overview/)               |
| GET    | `/events`                                 | [List events](https://releva.ai/documentation/reference/api/operations/listevents/)                                                                                       | [Events](https://releva.ai/documentation/reference/events/overview/)                         |
| POST   | `/events`                                 | [Send custom events](https://releva.ai/documentation/reference/api/operations/sendcustomevents/)                                                                          | [Events](https://releva.ai/documentation/reference/events/overview/)                         |
| POST   | `/search`                                 | [Send search events](https://releva.ai/documentation/reference/api/operations/sendsearchevents/)                                                                          | [Events](https://releva.ai/documentation/reference/events/overview/)                         |
| POST   | `/carts`                                  | [Report paid orders](https://releva.ai/documentation/reference/api/operations/reportpaidorders/)                                                                          | [Orders and refunds](https://releva.ai/documentation/reference/orders/overview/)             |
| POST   | `/refunds`                                | [Report refunds](https://releva.ai/documentation/reference/api/operations/reportrefunds/)                                                                                 | [Orders and refunds](https://releva.ai/documentation/reference/orders/overview/)             |
| GET    | `/loyalty-link`                           | [Get a profile's loyalty page link](https://releva.ai/documentation/reference/api/operations/getloyaltylink/)                                                             | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| GET    | `/profiles`                               | [Get a profile](https://releva.ai/documentation/reference/api/operations/getprofile/)                                                                                     | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| POST   | `/profiles`                               | [Create or update profiles](https://releva.ai/documentation/reference/api/operations/upsertprofiles/)                                                                     | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| DELETE | `/profiles`                               | [Delete a profile](https://releva.ai/documentation/reference/api/operations/deleteprofile/)                                                                               | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| POST   | `/profiles/exports`                       | [Export a profile's data](https://releva.ai/documentation/reference/api/operations/exportprofiledata/)                                                                    | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| POST   | `/register`                               | [Record a registration](https://releva.ai/documentation/reference/api/operations/registerprofile/)                                                                        | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| POST   | `/subscribers/sync`                       | [Start a subscriber sync](https://releva.ai/documentation/reference/api/operations/startsubscribersync/)                                                                  | [Profiles](https://releva.ai/documentation/reference/profiles/overview/)                     |
| POST   | `/companies`                              | [Create or update companies](https://releva.ai/documentation/reference/api/operations/upsertcompanies/)                                                                   | [Companies (B2B)](https://releva.ai/documentation/reference/companies/overview/)             |
| DELETE | `/companies/{companyId}`                  | [Delete a company](https://releva.ai/documentation/reference/api/operations/deletecompany/)                                                                               | [Companies (B2B)](https://releva.ai/documentation/reference/companies/overview/)             |
| POST   | `/roles`                                  | [Link profiles to companies](https://releva.ai/documentation/reference/api/operations/upsertroles/)                                                                       | [Companies (B2B)](https://releva.ai/documentation/reference/companies/overview/)             |
| DELETE | `/roles/{companyId}/{emailOrPhone}`       | [Remove a profile from a company](https://releva.ai/documentation/reference/api/operations/deleterole/)                                                                   | [Companies (B2B)](https://releva.ai/documentation/reference/companies/overview/)             |
| POST   | `/subscribe`                              | [Subscribe a profile or update its subscriptions](https://releva.ai/documentation/reference/api/operations/subscribe/)                                                    | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| POST   | `/unsubscribe`                            | [Unsubscribe a profile](https://releva.ai/documentation/reference/api/operations/unsubscribe/)                                                                            | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| GET    | `/unsubscribe/oneclick/{payload}`         | [Open an unsubscribe link](https://releva.ai/documentation/reference/api/operations/openunsubscribelink/)                                                                 | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| POST   | `/unsubscribe/oneclick/{payload}`         | [One-click unsubscribe (RFC 8058)](https://releva.ai/documentation/reference/api/operations/oneclickunsubscribe/)                                                         | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| GET    | `/subscribe/oneclick/{payload}`           | [Open a subscribe (confirmation) link](https://releva.ai/documentation/reference/api/operations/opensubscribelink/)                                                       | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| POST   | `/subscribe/request`                      | [Subscribe from the browser (double opt-in aware)](https://releva.ai/documentation/reference/api/operations/requestsubscribe/)                                            | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| POST   | `/subscribe/check`                        | [Check whether an email has a consent history](https://releva.ai/documentation/reference/api/operations/checksubscribed/)                                                 | [Consent and subscriptions](https://releva.ai/documentation/reference/consent/overview/)     |
| POST   | `/campaigns/{id}/runs`                    | [Run a webhook-triggered campaign](https://releva.ai/documentation/reference/api/operations/runwebhookcampaign/)                                                          | [Campaign runs](https://releva.ai/documentation/reference/campaigns/overview/)               |
| GET    | `/webhooks/events`                        | [Record a webhook open or click](https://releva.ai/documentation/reference/api/operations/trackwebhookevent/)                                                             | [Webhooks](https://releva.ai/documentation/reference/webhooks/overview/)                     |
| GET    | `/webhooks/events/{accessToken}`          | [Record a webhook open or click (token in the path)](https://releva.ai/documentation/reference/api/operations/trackwebhookeventwithpathtoken/)                            | [Webhooks](https://releva.ai/documentation/reference/webhooks/overview/)                     |
| POST   | `/push`                                   | [Get the product blocks for a page (access token in the header)](https://releva.ai/documentation/reference/api/operations/pushcontextwithheader/)                         | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/impressions/{accessToken}`              | [Report that product blocks or banner blocks were seen](https://releva.ai/documentation/reference/api/operations/trackimpressions/)                                       | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/impressions`                            | [Report that blocks were seen (access token in the header)](https://releva.ai/documentation/reference/api/operations/trackimpressionswithheader/)                         | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/push/events/{accessToken}`              | [Report a banner, story or page engagement event](https://releva.ai/documentation/reference/api/operations/trackstorefrontevent/)                                         | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/push/events`                            | [Report a banner, story or page engagement event (access token in the header)](https://releva.ai/documentation/reference/api/operations/trackstorefronteventwithheader/)  | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/orders/status-reference/{accessToken}`  | [Look up an order for the order status page](https://releva.ai/documentation/reference/api/operations/lookuporderstatusreference/)                                        | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/orders/status-reference`                | [Look up an order for the order status page (access token in the header)](https://releva.ai/documentation/reference/api/operations/lookuporderstatusreferencewithheader/) | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/push/{accessToken}`                     | [Send a page view from the storefront (tracking snippet)](https://releva.ai/documentation/reference/api/operations/pushcontext/)                                          | [SDK calls](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/)   |
| POST   | `/appPush/tokens`                         | [Register a mobile app push token](https://releva.ai/documentation/reference/api/operations/registerapppushtoken/)                                                        | [Push notifications](https://releva.ai/documentation/reference/push-notifications/overview/) |
| POST   | `/pushSubscriptions/{accessToken}`        | [Register a browser push subscription](https://releva.ai/documentation/reference/api/operations/registerwebpushsubscription/)                                             | [Push notifications](https://releva.ai/documentation/reference/push-notifications/overview/) |
| GET    | `/inbox/messages`                         | [List inbox messages](https://releva.ai/documentation/reference/api/operations/listinboxmessages/)                                                                        | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| GET    | `/inbox/unread-count`                     | [Count unread inbox messages](https://releva.ai/documentation/reference/api/operations/getinboxunreadcount/)                                                              | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| POST   | `/inbox/messages/{messageId}/read`        | [Mark a message as read](https://releva.ai/documentation/reference/api/operations/markinboxmessageread/)                                                                  | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| POST   | `/inbox/messages/read-all`                | [Mark all messages as read](https://releva.ai/documentation/reference/api/operations/markallinboxmessagesread/)                                                           | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| DELETE | `/inbox/messages/{messageId}`             | [Delete a message](https://releva.ai/documentation/reference/api/operations/deleteinboxmessage/)                                                                          | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| POST   | `/inbox/messages/{messageId}/action`      | [Report a tap on a message](https://releva.ai/documentation/reference/api/operations/trackinboxmessageaction/)                                                            | [App inbox](https://releva.ai/documentation/reference/inbox/overview/)                       |
| POST   | `/searchAsYouType/{accessToken}`          | [Search products as the shopper types](https://releva.ai/documentation/reference/api/operations/searchasyoutype/)                                                         | [Search as you type](https://releva.ai/documentation/reference/search-as-you-type/overview/) |
| GET    | `/surveys/{token}`                        | [Open a survey](https://releva.ai/documentation/reference/api/operations/opensurvey/)                                                                                     | [Surveys and NPS](https://releva.ai/documentation/reference/surveys/overview/)               |
| POST   | `/surveys/{token}/submissions`            | [Submit survey answers](https://releva.ai/documentation/reference/api/operations/submitsurvey/)                                                                           | [Surveys and NPS](https://releva.ai/documentation/reference/surveys/overview/)               |
| POST   | `/nps/{token}/submissions`                | [Submit an NPS answer](https://releva.ai/documentation/reference/api/operations/submitnps/)                                                                               | [Surveys and NPS](https://releva.ai/documentation/reference/surveys/overview/)               |
| PUT    | `/partners/domains`                       | [Update, pause or resume a shop](https://releva.ai/documentation/reference/api/operations/partnerupdatedomain/)                                                           | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains`                       | [Provision a shop](https://releva.ai/documentation/reference/api/operations/partnerprovisiondomain/)                                                                      | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| GET    | `/partners/subscriptions`                 | [List Releva plans](https://releva.ai/documentation/reference/api/operations/partnerlistsubscriptions/)                                                                   | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains/trialDays`             | [Get remaining trial days](https://releva.ai/documentation/reference/api/operations/partnergettrialdays/)                                                                 | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains/subscriptions/confirm` | [Confirm a plan and billing period](https://releva.ai/documentation/reference/api/operations/partnerconfirmsubscriptions/)                                                | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains/uninstall`             | [Report that the app was uninstalled](https://releva.ai/documentation/reference/api/operations/partneruninstalldomain/)                                                   | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains/usageRecords/confirm`  | [Confirm a usage charge](https://releva.ai/documentation/reference/api/operations/partnerconfirmusagecharge/)                                                             | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| POST   | `/partners/domains/profiles`              | [Create or update profiles for a shop](https://releva.ai/documentation/reference/api/operations/partnerupsertprofiles/)                                                   | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| DELETE | `/partners/domains/profiles`              | [Delete a profile of a shop](https://releva.ai/documentation/reference/api/operations/partnerdeleteprofile/)                                                              | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |
| GET    | `/users/partnerSignin/{token}/{payload}`  | [Single sign-on link into the Releva admin](https://releva.ai/documentation/reference/api/operations/partnersignin/)                                                      | [Partner API](https://releva.ai/documentation/reference/partners/overview/)                  |

## Next steps

* [API overview](https://releva.ai/documentation/reference/api/): Open the full reference of every endpoint, grouped by area, with its parameters and responses.
* [Endpoints the Releva SDKs call](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call/): See the storefront and app endpoints the SDKs call, if you build your own client.