# Releva > Releva is the AI agent for B2C online stores. Learn how it works, follow step-by-step guides and integrate with the Releva API. ## Documentation Sets - [Complete documentation](https://releva.ai/documentation/llms-full.txt): every page of the Releva documentation as Markdown - [Learn](https://releva.ai/documentation/llms-learn.txt): concepts and how Releva works - [Guides](https://releva.ai/documentation/llms-guides.txt): step-by-step tasks in the Releva admin - [Integrations](https://releva.ai/documentation/llms-integrations.txt): connect a store, app or platform - [Reference](https://releva.ai/documentation/llms-reference.txt): API overviews, authentication and SDK reference - [What's new](https://releva.ai/documentation/llms-what-s-new.txt): monthly digests and the SDK changelog ## API contract - [OpenAPI contract](https://releva.ai/documentation/openapi.yaml): the public Releva API as one OpenAPI 3.1.0 file (YAML), the source of the endpoint pages under https://releva.ai/documentation/reference/api/ ## Documentation - [Releva documentation](https://releva.ai/documentation/index.md): Releva is the AI agent for B2C online stores. Learn how it works, follow step-by-step guides and integrate with the Releva API. - [How A/B tests work](https://releva.ai/documentation/learn/ab-tests/how-ab-tests-work.md): What a Releva A/B test holds back, how visitors land in the control or treatment group, which days and events the results count, and how to read status, change and significance. - [How accounts, shops and billing work](https://releva.ai/documentation/learn/account/how-accounts-shops-and-billing-work.md): What an account and a shop are, who can sign in, how a new shop is created and activated, how plans, trials, billing periods, usage limits and invoices work, and what to do after you install the app. - [How analytics works](https://releva.ai/documentation/learn/analytics/how-analytics-works.md): What the Analytics dashboard tabs show, what "attributed" means, how funnels, RFM, Audience Performance and cohorts are measured, and how to follow Releva traffic in Google Analytics. - [What each Analytics metric means](https://releva.ai/documentation/learn/analytics/what-each-analytics-metric-means.md): Every card and tile on the eight Analytics › Dashboard tabs, what it counts and what it is compared with. - [How files work](https://releva.ai/documentation/learn/assets/how-files-work.md): What Assets › Files stores, which image and document formats you can upload, what a file's links are, where the channels pick files from, and what deleting a file does. - [How banners work](https://releva.ai/documentation/learn/banner-blocks/how-banners-work.md): What a banner and a banner block are, how they are served on a page, who sees them, when they stop showing, and how impressions, clicks, conversions and purchases are counted. - [How Brand Identity is used](https://releva.ai/documentation/learn/brand-identity/how-brand-identity-is-used.md): What Releva keeps in your Brand Identity, which features read it, what each status means and why a re-read never overwrites a confirmed brand. - [How campaigns work](https://releva.ai/documentation/learn/campaigns/how-campaigns-work.md): What a campaign is in Releva, how One Off and Continuous differ, what Campaign Scope and the target segment decide, how repeat entry, launch, statuses, locks, goals and statistics work, and where triggered campaigns live now. - [How catalog triggers work](https://releva.ai/documentation/learn/catalog-triggers/how-catalog-triggers-work.md): What a catalog trigger is, the catalog and audience rules, when Releva checks them, the event each one produces, how triggered workflows use it, and what the Events dispatched number means. - [How your catalog gets into Releva](https://releva.ai/documentation/learn/catalog/how-your-catalog-gets-into-releva.md): The three ways products reach Releva, how a product is identified and updated, when it becomes visible, and what locale and availability mean. - [Companies and roles](https://releva.ai/documentation/learn/companies/companies-and-roles.md): How Releva models B2B customers, how people are linked to companies, how updates and deletes behave, and where the data is used. - [How consent works in Releva](https://releva.ai/documentation/learn/consent/how-consent-works-in-releva.md): What subscribed, unsubscribed and subscriptions mean on a profile, which campaigns the marketing status gates, what user-visible subscriptions do, and how Internal and External subscription management differ. - [Use these docs with an AI assistant](https://releva.ai/documentation/learn/docs-for-agents/use-these-docs-with-an-ai-assistant.md): The Markdown copy of every page, the Copy page menu, llms.txt, llms-full.txt and the per-section files, so Claude, ChatGPT or any other AI assistant can read the Releva documentation. - [How dynamic coupons work](https://releva.ai/documentation/learn/dynamic-coupons/how-dynamic-coupons-work.md): What a dynamic coupon list is, how a merge tag hands each recipient a different code, what happens when a list runs out, and how uploaded lists differ from Shopify coupons that Releva creates for you. - [How emails work](https://releva.ai/documentation/learn/emails/how-emails-work.md): What an email is in Releva, what the editor asks for, how product blocks and merge tags personalise it, how campaigns and workflows send it, and which events feed its results. - [How events get into Releva](https://releva.ai/documentation/learn/events/how-events-get-into-releva.md): The three ways events reach Releva, how an event is attached to a profile, what a custom event can carry, when it becomes visible and where it is used. - [How exports work](https://releva.ai/documentation/learn/exports/how-exports-work.md): What an export is, the One Time and Periodic types, the sixteen scopes, how the CSV is built and delivered, how schedules run, and what you can change after saving. - [How Facebook ads work](https://releva.ai/documentation/learn/facebook-ads/how-facebook-ads-work.md): What a Releva Facebook ad is, what the Meta connection and Facebook product sets provide, what happens in Meta when you save and when you send an ad, and which settings you can change later. - [How Google Ads work in Releva](https://releva.ai/documentation/learn/google-ads/how-google-ads-work-in-releva.md): What a Google Ad is, what the Google connection needs, what happens when you save, launch, edit or delete one, and where its stats and recommendations come from. - [How the App Inbox works](https://releva.ai/documentation/learn/inbox/how-the-app-inbox-works.md): What an App Inbox message is, how it differs from a push notification, who receives it, how it is personalised, when it expires, what read and delete mean, how the app keeps its inbox in sync, and where the results show up. - [How layouts work](https://releva.ai/documentation/learn/layouts/how-layouts-work.md): What a layout under Assets › Layouts is, the three scopes (Web, Email, Search As You Type), the Visual and HTML editors, what the markup can use, where a layout is chosen, how Edit on my site previews a Web or Search layout on your shop, and what copying and deleting do. - [How loyalty points work](https://releva.ai/documentation/learn/loyalty/how-loyalty-points-work.md): Which events earn points, how earn and redeem rules are applied, when points expire or are reversed on refund, how shoppers reach their loyalty page, and where loyalty shows up elsewhere in Releva. - [How sender verification and click tracking work](https://releva.ai/documentation/learn/messaging/how-sender-verification-and-click-tracking-work.md): What Settings › Messaging controls, why Releva needs a DKIM record and a click-tracking record on your sender domain, what each one gates, how the checks run, and how the daily message limits fit together. - [How orders and refunds work](https://releva.ai/documentation/learn/orders/how-orders-and-refunds-work.md): How a paid order gets into Releva, why one order id is recorded once, what a refund changes, and where orders and refunds show up in the admin. - [How the Partner API works](https://releva.ai/documentation/learn/partners/how-the-partner-api-works.md): Who the Partner API is for, the two credentials every call carries, how a merchant's shop is identified, what internal and external billing mean, how plans, billing periods and usage charges flow between you and Releva, which webhooks Releva calls on your side, and the life cycle of a partner shop from install to uninstall. - [Using Releva through your platform](https://releva.ai/documentation/learn/partners/using-releva-through-your-platform.md): What is different in the Releva admin when your e-commerce platform or app created your Releva shop for you: the first sign-in, the plan confirmation page, the setup wizard, the fields you cannot edit and the banners your platform controls. - [How pipelines work](https://releva.ai/documentation/learn/pipelines/how-pipelines-work.md): What a pipeline forwards, the filter and transform functions, the payload your destination receives, how webhook, S3 and Google Cloud Storage outputs deliver and retry, and what the four counters mean. - [How product blocks work](https://releva.ai/documentation/learn/product-blocks/how-product-blocks-work.md): What a product block is, how pages and tokens connect it to your storefront, the three modes, the rules that decide whether a visitor sees it, and what the numbers on its card count. - [How product feeds work](https://releva.ai/documentation/learn/product-feeds/how-product-feeds-work.md): What a product feed is, how scope, algorithm, secondary ranking and rules combine to pick products, and where feeds are used. - [How product trends work](https://releva.ai/documentation/learn/product-trends/how-product-trends-work.md): What each of the eleven product trend cards counts, which events feed them, how the period and the top-12 limit apply, and why some cards stay empty. - [How customer profiles work](https://releva.ai/documentation/learn/profiles/how-profiles-work.md): What a profile is, how Releva identifies one person across id, email and phone number, the ways profiles get in, and what consent, subscriptions, tags and custom fields mean. - [How push notifications work](https://releva.ai/documentation/learn/push-notifications/how-push-notifications-work.md): What a Releva push notification is, which channels it reaches, how a browser or app opts in, what the delivery options and the daily limit do, and which events the statistics count. - [How the Sales Agent works](https://releva.ai/documentation/learn/sales-agent/how-the-sales-agent-works.md): The Sales Agent is the AI shopping assistant in a chat window on your site. Learn where it shows, what it answers from, what happens when it cannot answer, and what you manage in Agentic › Sales Agent. - [How search as you type works](https://releva.ai/documentation/learn/search-as-you-type/how-search-as-you-type-works.md): What search as you type does on your shop, how Releva picks and ranks the products, how filters, synonyms and blocked words change the results, how clicks are attributed and what the statistics tiles count. - [How segments work](https://releva.ai/documentation/learn/segments/how-segments-work.md): What a segment is, what the Behavior, Profile filter, Facebook and Google scopes mean, how rules and filters combine, what Calculate Segment and Export Segment do, and some segments worth building first. - [How Releva connects to your shop](https://releva.ai/documentation/learn/shop-settings/how-releva-connects-to-your-shop.md): The two keys of a shop, what the tracking snippet does, how the catalog pull sync works and what the Shopify app embed replaces. - [How SMS work](https://releva.ai/documentation/learn/sms/how-sms-work.md): What an SMS is in Releva, who receives it, how merge tags, link shortening, length and encoding work, what the daily limit does, how test messages and statistics work, and which providers Releva sends through. - [How stories work](https://releva.ai/documentation/learn/stories/how-stories-work.md): What a story is, where it is shown, who sees it, when it stops showing, and how impressions, clicks, conversions and purchases are counted. - [How surveys and NPS work](https://releva.ai/documentation/learn/surveys/how-surveys-and-nps-work.md): The two feedback tools under Data Platform, how respondents reach a survey by personal or public link, how an NPS survey is picked for a visitor and how often it repeats, where the answers go, and how to export them. - [How segment syncs work](https://releva.ai/documentation/learn/sync-segments/how-segment-syncs-work.md): What a segment sync is, how it differs from a Google or Facebook segment, when Releva pushes profiles to Facebook or Google Analytics, and what the lookalike options mean. - [How TikTok tracking works in Releva](https://releva.ai/documentation/learn/tiktok/how-tiktok-tracking-works.md): What the TikTok connection under Settings › TikTok does, which eight standard events Releva sends to your pixel from its servers, what each event carries, how the event list and Backend Tracking gate them, how to avoid duplicates, and what the _ttp browser id is for. - [How Viber messages work](https://releva.ai/documentation/learn/viber/how-viber-messages-work.md): What a Viber message is in Releva, Marketing versus Transactional scope, Text versus Multimedia mode, who receives it, merge tags and link shortening, the daily limit, Viber transactional templates per provider, test messages and statistics. - [How webhooks work](https://releva.ai/documentation/learn/webhooks/how-webhooks-work.md): What a webhook is in Releva, the difference between Standard and Custom webhooks, what Releva sends and when, how authentication, retries, the daily limit, skipping and open/click tracking work, and which numbers the card shows. - [How WhatsApp messages work](https://releva.ai/documentation/learn/whatsapp/how-whatsapp-messages-work.md): What a WhatsApp template is in Releva, the two ways to connect a WhatsApp Business Account, the three template types, Meta approval and statuses, who receives a message, merge tags, the daily limit, test messages, importing, statistics and how delivery reports reach Releva. - [How workflows work](https://releva.ai/documentation/learn/workflows/how-workflows-work.md): The three workflow types (one-off, continuous, triggered), the step types on the canvas, scope and segment, repeat entry, what Launch and the On switch do, and when a step actually sends. - [Check and stop an A/B test](https://releva.ai/documentation/guides/ab-tests/check-and-stop-an-ab-test.md): Open a running A/B test under Analytics › A/B Tests, read the status, influence and significance of each indicator, compare the control and treatment groups, stop the test and, if you want, delete it. - [Start an A/B test](https://releva.ai/documentation/guides/ab-tests/start-an-ab-test.md): Start a site-wide A/B test under Analytics › A/B Tests by choosing the control group fraction and the hypothesis, so you can measure what Releva adds to your shop. - [Check your usage and subscription](https://releva.ai/documentation/guides/account/check-your-usage-and-subscription.md): Open the account Usage tab to see profiles, active profiles, subscribers and activity per shop for a period, then open a shop's Subscriptions & Usage tab to see its plan. - [Invite a collaborator](https://releva.ai/documentation/guides/account/invite-a-collaborator.md): Add a colleague to your Releva account from Account › Collaborators, choose their role and send the invitation e-mail. - [Check how your store is doing](https://releva.ai/documentation/guides/analytics/check-how-your-store-is-doing.md): Pick a period on Analytics › Dashboard, read attributed and total revenue, the funnel and the attribution breakdown, open the attributed orders, then look at the other seven tabs. - [Create a funnel](https://releva.ai/documentation/guides/analytics/create-a-funnel.md): Define a funnel under Analytics › Customer Insights › Funnels from an event action and two standard events, and read how many profiles reached each step. - [Upload a file and use it in your messages](https://releva.ai/documentation/guides/assets/upload-a-file-and-use-it-in-your-messages.md): Upload an image or document to Assets › Files, find it again, copy its link for an email, push notification or other message, and change or delete it later. - [Choose who sees a banner](https://releva.ai/documentation/guides/banner-blocks/choose-who-sees-a-banner.md): Open a banner under Marketing Channels › Banners, set its behavioral segment, switch it to Show until click with a cooldown, and save. - [Show a banner on your site](https://releva.ai/documentation/guides/banner-blocks/show-a-banner-on-your-site.md): Add a static banner block to a Personalization page under Personalization › Banner Blocks, pick its exact spot on your shop with Position on my site, switch it on and check its numbers. - [Create a banner](https://releva.ai/documentation/guides/banners/create-a-banner.md): Create a banner under Marketing Channels › Banners, build it in the Releva builder with a heading and a sign-up form, preview it, choose its segment and save it. - [Set up your Brand Identity](https://releva.ai/documentation/guides/brand-identity/set-up-your-brand-identity.md): Let Releva read your website, check the logos, colors, font and voice it found, then confirm them so your emails, pop-ups and assistant look and sound like you. - [Create a one-off email campaign](https://releva.ai/documentation/guides/campaigns/create-a-one-off-email-campaign.md): Build a one-off campaign under Campaigns › One Off by naming it, picking an email, choosing the scope and target segment, setting the launch options and goal, and saving it as a draft. - [Change a catalog trigger](https://releva.ai/documentation/guides/catalog-triggers/change-a-catalog-trigger.md): Open a catalog trigger under Data Platform › Catalog Triggers, narrow its Price decrease rule with a Discount % filter, save it, and learn what Delete and Make a copy do. - [Create a catalog trigger](https://releva.ai/documentation/guides/catalog-triggers/create-a-catalog-trigger.md): Create a catalog trigger under Data Platform › Catalog Triggers that pairs a product change such as Became in stock with an audience action such as Viewed product, so a triggered workflow can message the right people. - [Filter your product catalog](https://releva.ai/documentation/guides/catalog/filter-your-product-catalog.md): Narrow the Products list by id, SKU, locale, description and update time, and share the filtered view. - [Find a product in your catalog](https://releva.ai/documentation/guides/catalog/find-a-product.md): Open Data Platform › Products, search by name and open a product to see what Releva knows about it. - [View a product's details, interactions and recommendations](https://releva.ai/documentation/guides/catalog/view-product-details.md): Read every synced field of a product, its orders and revenue for the last 3 months, and the products Releva recommends next to it. - [Add a company](https://releva.ai/documentation/guides/companies/add-a-company.md): Create a B2B company by hand in Data Platform › Companies with the Company Id your own systems use. - [Edit or delete a company](https://releva.ai/documentation/guides/companies/edit-a-company.md): Change a B2B company's name, contact details and tags from its detail page in Data Platform › Companies, or delete it. - [Find a company and see its activity](https://releva.ai/documentation/guides/companies/find-a-company.md): Open Data Platform › Companies, search for a B2B company and open it to see its details, linked profiles and aggregated statistics. - [Check a customer's subscription status](https://releva.ai/documentation/guides/consent/check-a-customers-subscription-status.md): Open a profile under Data Platform › Profiles to see whether the customer receives marketing messages, since when, and which subscriptions they hold. - [Choose how Releva manages subscriptions](https://releva.ai/documentation/guides/consent/choose-how-releva-manages-subscriptions.md): Set Subscription Management to Internal or External, choose whether sign-up forms wait for an email confirmation, and define the subscriptions your customers can see. - [Unsubscribe a customer from marketing messages](https://releva.ai/documentation/guides/consent/unsubscribe-a-customer.md): Opt one profile out of email, SMS, Viber, WhatsApp and webhook messages from its profile page, and subscribe it again if needed. - [Add codes to a coupon list](https://releva.ai/documentation/guides/dynamic-coupons/add-codes-to-a-coupon-list.md): Top up an existing dynamic coupon list in Data Platform › Dynamic Coupons by uploading a second .txt file of codes. - [Add codes to a Shopify coupon](https://releva.ai/documentation/guides/dynamic-coupons/add-codes-to-a-shopify-coupon.md): Ask Releva to create extra codes for a Shopify coupon in Data Platform › Dynamic Coupons, ahead of a send to more recipients than the pool holds. - [Change a Shopify coupon](https://releva.ai/documentation/guides/dynamic-coupons/change-a-shopify-coupon.md): Change the discount, combinations or active dates of a Shopify coupon in Data Platform › Dynamic Coupons, and see the history of its earlier settings. - [Check how many coupon codes are left](https://releva.ai/documentation/guides/dynamic-coupons/check-how-many-coupon-codes-are-left.md): Find a dynamic coupon list in Data Platform › Dynamic Coupons and see how many unused codes it still has. - [Create Shopify coupons](https://releva.ai/documentation/guides/dynamic-coupons/create-shopify-coupons.md): Let Releva create unique one-time discount codes in your Shopify store, with the discount, combinations and active dates you choose, and hand one to each recipient. - [Delete a coupon list](https://releva.ai/documentation/guides/dynamic-coupons/delete-a-coupon-list.md): Remove a dynamic coupon list and all its codes from Data Platform › Dynamic Coupons. - [Delete a Shopify coupon](https://releva.ai/documentation/guides/dynamic-coupons/delete-a-shopify-coupon.md): Remove a Shopify coupon from Data Platform › Dynamic Coupons, together with the codes in your Shopify store that were not sent yet. - [Re-authorize Releva in Shopify](https://releva.ai/documentation/guides/dynamic-coupons/re-authorize-releva-in-shopify.md): Give the Releva app in Shopify the permission to create discounts again, so Releva can create and manage the codes of your Shopify coupons. - [Upload a list of coupon codes](https://releva.ai/documentation/guides/dynamic-coupons/upload-a-list-of-coupon-codes.md): Create a dynamic coupon list in Data Platform › Dynamic Coupons from a .txt file of codes that already exist in your shop. - [Build an email in the visual editor](https://releva.ai/documentation/guides/emails/build-an-email-in-the-visual-editor.md): Create a blank email under Marketing Channels › Emails, build it from structures and blocks in the visual editor, personalise it with merge tags and a product block, and save it. - [Check how an email performs](https://releva.ai/documentation/guides/emails/check-how-an-email-performs.md): Read an email's results on its card in the Emails list, create a segment from a result, then open its Statistics page to see clicks on the email itself, the funnel, the daily chart and the products bought. - [Edit an HTML email](https://releva.ai/documentation/guides/emails/edit-an-html-email.md): Open an HTML email under Marketing Channels › Emails, change its code with a live preview, set the sender and daily limit in Advanced settings, save it, or make a copy and save that. - [Find an email and check its results](https://releva.ai/documentation/guides/emails/find-an-email-and-check-its-results.md): Search the Emails list under Marketing Channels › Emails, set the period, and read Sent, Delivered, Opened, Clicks, Purchases and Revenue on an email's card. - [Check that an event reached Releva](https://releva.ai/documentation/guides/events/check-that-an-event-reached-releva.md): Open Data Platform › Events, filter by event action and read the raw event to confirm that an event you sent was stored with the right data. - [Export events to a file](https://releva.ai/documentation/guides/events/export-events.md): Filter Data Platform › Events, choose which custom fields become columns and receive the export file by e-mail. - [See all events of a customer](https://releva.ai/documentation/guides/events/see-all-events-of-a-customer.md): From Data Platform › Events, open the profile behind an event to see every event Releva tracked for that customer. - [Export results for a date range](https://releva.ai/documentation/guides/exports/export-results-for-a-date-range.md): Create a One Time export under Analytics › Exports that e-mails you a CSV with the results of your emails, campaigns or other elements for a period you choose. - [Schedule a recurring export](https://releva.ai/documentation/guides/exports/schedule-a-recurring-export.md): Create a Periodic export under Analytics › Exports that e-mails a CSV every week, month or year, and switch it on. - [Check how your Facebook ads perform](https://releva.ai/documentation/guides/facebook-ads/check-how-your-facebook-ads-perform.md): Read the Meta results of each Facebook ad on its card under Marketing Channels › Facebook Ads, change the period, check the ad set and product set status, and export the figures by email. - [Connect your Meta account to Releva](https://releva.ai/documentation/guides/facebook-ads/connect-your-meta-account-to-releva.md): Connect Facebook under Settings › Facebook & Whatsapp, choose your Meta business, ad account, page and pixel, set the catalog and audience sync schedules and targeting countries, save, and run the first catalog sync. - [Copy a Facebook ad to change its objective](https://releva.ai/documentation/guides/facebook-ads/copy-a-facebook-ad-to-change-its-objective.md): Use Make a copy on a saved Facebook ad to change settings that are locked after the first save, such as Objective, Optimization Goal, placement, Promoted Visual, Promoted Products or Attribution, and save the result as a new ad with its own Meta campaign. - [Create a Facebook ad](https://releva.ai/documentation/guides/facebook-ads/create-a-facebook-ad.md): Create a Products Carousel Facebook ad under Marketing Channels › Facebook Ads with a Sales objective, a call to action, a Facebook product set, a daily budget and a duration, save it to create the campaign in your Meta ad account, then choose how to send it. - [Create a Facebook product set](https://releva.ai/documentation/guides/facebook-ads/create-a-facebook-product-set.md): Create a Facebook product set under Data Platform › Facebook Product Sets, choose Full or a Ranked subset from a product feed and a segment, save, and check that Releva synchronised it to your Meta catalog. - [Create your shop](https://releva.ai/documentation/guides/get-started/create-your-shop.md): Open avatar menu › Account › New Shop, fill in the Create Shop form, create the shop, then confirm the brand Releva reads from your website and continue in the How-To Guide. Shopify shops are created by installing the app instead. - [Get started with Releva](https://releva.ai/documentation/guides/get-started/get-started-with-releva.md): Welcome to Releva. See how you get into your shop and what to turn on first, in the order of Releva's How-To Guide. Confirm your brand, install Releva, set up your sender, turn on the abandoned cart and browsing workflows, the subscription banner and product recommendations, then welcome new subscribers and reach shoppers on Facebook. - [Check how your Google Ads perform](https://releva.ai/documentation/guides/google-ads/check-how-your-google-ads-perform.md): Find a Google Ad under Marketing Channels › Google Ads, read its stats for a period and open Google's recommendations for the campaign. - [Connect Google Ads to Releva](https://releva.ai/documentation/guides/google-ads/connect-google-ads-to-releva.md): Connect a Google account under Settings › Google, choose the Google Ads account Releva creates campaigns in, link Google Analytics and add the required Performance Max assets. - [Copy a layout and change its HTML](https://releva.ai/documentation/guides/layouts/copy-a-layout-and-change-its-html.md): Filter Assets › Layouts by scope, open an existing email layout, make a copy, rename it and change its Handlebars markup in the HTML editor. - [Create a layout for email product blocks](https://releva.ai/documentation/guides/layouts/create-a-layout-for-email-product-blocks.md): Create an Email-scope layout under Assets › Layouts in the Visual editor, style the product name and price, and save it so you can pick it in an email's product block. - [Customize your loyalty page](https://releva.ai/documentation/guides/loyalty/customize-your-loyalty-page.md): Change the logo position, colours and wording of the shopper-facing loyalty page under Data Platform › Loyalty › Display Settings, and check the result in the live preview. - [Set up your loyalty program](https://releva.ai/documentation/guides/loyalty/set-up-your-loyalty-program.md): Create an earn rule that gives points for every EUR of an order and a redeem rule that lets shoppers buy a coupon with their points, under Data Platform › Loyalty. - [Set up your email sender and DNS records](https://releva.ai/documentation/guides/messaging/set-up-your-email-sender-and-dns-records.md): Set the sender name, sender address and reply-to address under Settings › Messaging › Emails, then publish the two CNAME records (DKIM and click tracking) that let Releva send email and track links. - [Check Releva on your site with debug mode](https://releva.ai/documentation/guides/on-your-site/check-releva-on-your-site-with-debug-mode.md): Open a page of your shop with ?rlv_mode=debug to see every product block, banner and story Releva would place there, including the ones that are switched off, with an outline around each product block. - [Preview your site as a customer](https://releva.ai/documentation/guides/on-your-site/preview-your-site-as-a-customer.md): Open a customer under Data Platform › Profiles and select Impersonate to browse your own shop as that customer, so you can check which banners, stories and product blocks they get. - [Check that a refund was recorded](https://releva.ai/documentation/guides/orders/check-that-a-refund-was-recorded.md): Open the customer's profile and filter Recent Events by Refund to confirm that a refund sent with POST /api/v0/refunds was applied to the order. - [See a customer's orders](https://releva.ai/documentation/guides/orders/see-a-customers-orders.md): Open a customer's profile and filter Recent Events by Cart Checkout Completed to see every order Releva recorded for them, with the products and the order total. The Aggregated Statistics tab sums up their orders for the last month and the last 3 months. - [Send events to a webhook with a pipeline](https://releva.ai/documentation/guides/pipelines/send-events-to-a-webhook-with-a-pipeline.md): Create a pipeline under Data Platform › Pipelines that forwards selected events to an HTTPS endpoint, then switch it on from the list. - [Create a product block](https://releva.ai/documentation/guides/product-blocks/create-a-product-block.md): Add a product block to a Personalization page under Personalization › Product Blocks, pick its mode, feed, audience, layout and position, save it switched off, place it on your shop with Position on my site and check it in debug mode. - [Turn on a product block and check its results](https://releva.ai/documentation/guides/product-blocks/turn-on-a-product-block-and-check-its-results.md): Switch a product block on from the Personalization › Product Blocks list, see it live on your shop, and read its page views, impressions, clicks, cart additions, purchases and revenue on its card and on the Statistics page. - [Add a custom rule to a product feed](https://releva.ai/documentation/guides/product-feeds/add-a-custom-rule-to-a-product-feed.md): Boost, bury, include or exclude products by one of your own product fields, such as color or brand, in Data Platform › Product Feeds. - [Check how a product feed performs](https://releva.ai/documentation/guides/product-feeds/check-how-a-product-feed-performs.md): Read the clicks, purchases and revenue of a product feed on its card and on its Statistics page in Data Platform › Product Feeds. - [Create a product feed](https://releva.ai/documentation/guides/product-feeds/create-a-product-feed.md): Build a reusable product selection in Data Platform › Product Feeds by choosing a scope, an algorithm and the boosts and filters it applies. - [Export a product trend](https://releva.ai/documentation/guides/product-trends/export-a-product-trend.md): Export up to 100 ranked products of one product trend as a CSV that Releva e-mails to you. - [See which products are trending](https://releva.ai/documentation/guides/product-trends/see-which-products-are-trending.md): Open Analytics › Product Trends, pick a period and read the eleven trend cards that rank your categories and products by views, cart adds, purchases and revenue. - [Add a customer profile](https://releva.ai/documentation/guides/profiles/add-a-profile.md): Create a single customer profile by hand from Data Platform › Profiles › Add Profile, with name, email, phone, dates, subscriptions and tags. - [Edit a customer profile and add tags](https://releva.ai/documentation/guides/profiles/edit-a-profile.md): Open a profile from Data Platform › Profiles, select Edit, change its details or add tags, and save. Also how to delete a profile. - [Find a customer profile](https://releva.ai/documentation/guides/profiles/find-a-profile.md): Open Data Platform › Profiles, search by email, name, phone number or profile id, and open a profile to see what Releva knows about the customer. - [Import profiles from a CSV file](https://releva.ai/documentation/guides/profiles/import-profiles-from-a-csv-file.md): Upload a CSV file of customers under Data Platform › Profiles › Import Profiles, choose how existing profiles are treated, and read the result e-mail. Includes the exact column format. - [Add an App Inbox message to a push notification](https://releva.ai/documentation/guides/push-notifications/add-an-app-inbox-message-to-a-push-notification.md): Create a push notification with the App Inbox channel under Marketing Channels › Push Notifications: write the inbox message, let the push open the inbox, set how long the message stays, and save it as a draft. - [Create a mobile app push notification](https://releva.ai/documentation/guides/push-notifications/create-a-mobile-app-push-notification.md): Create an Android and iOS app push notification under Marketing Channels › Push Notifications with a subject, body, image, tag, expiry time and tap target, and save it as a draft. - [Create a web push notification](https://releva.ai/documentation/guides/push-notifications/create-a-web-push-notification.md): Create a Web push notification under Marketing Channels › Push Notifications with a subject, body, icon, image, tag, expiry time and link, and save it as a draft. - [Send a push notification with a workflow](https://releva.ai/documentation/guides/push-notifications/send-a-push-notification-with-a-workflow.md): Test a saved push notification and hand it to a new or existing workflow from Marketing Channels › Push Notifications. - [Add knowledge for the Sales Agent](https://releva.ai/documentation/guides/sales-agent/add-knowledge-for-the-sales-agent.md): Open Agentic › Sales Agent › Knowledge Base, add a page of your shop, a PDF or your own text as a document, check what the import made and publish it, so the Sales Agent can answer from it. - [Approve Sales Agent answers](https://releva.ai/documentation/guides/sales-agent/approve-sales-agent-answers.md): Open Agentic › Sales Agent › Knowledge Base › Q&A Review to approve, edit or reject the questions and answers made from your documents, and add your own pairs for questions shoppers asked that the Sales Agent could not answer. - [Check how the Sales Agent performs](https://releva.ai/documentation/guides/sales-agent/check-how-the-sales-agent-performs.md): Read the figures at the top of Agentic › Sales Agent for a period of your choice, and find the Sales Agent's attributed revenue on Analytics › Dashboard. - [Choose where the Sales Agent appears](https://releva.ai/documentation/guides/sales-agent/choose-where-the-sales-agent-appears.md): In Agentic › Sales Agent › Customize, use the URL filter to show the Sales Agent only on some pages or to keep it off pages such as checkout, choose the side of the screen, then save. - [Customize how the Sales Agent looks on your site](https://releva.ai/documentation/guides/sales-agent/customize-how-the-sales-agent-looks-on-your-site.md): In Agentic › Sales Agent › Customize, set the chat title and invite message, the launcher shape on desktop and mobile, the notification bar, how products show in replies and the chat colors, then save. - [Review Sales Agent conversations](https://releva.ai/documentation/guides/sales-agent/review-sales-agent-conversations.md): Open Agentic › Sales Agent › Conversations, find conversations by question, answer type or vote, read one, and send a better answer or a good one to Releva for review. - [Set up the Sales Agent welcome message](https://releva.ai/documentation/guides/sales-agent/set-up-the-sales-agent-welcome-message.md): In Agentic › Sales Agent › Personalization, write the message shoppers see when they open the chat, add quick-reply questions and other languages, and set the Fallback Message and Support Email. - [Turn the Sales Agent on or off](https://releva.ai/documentation/guides/sales-agent/turn-the-sales-agent-on-or-off.md): Use the Chat Bot switch in Agentic › Sales Agent to show the Sales Agent chat to your shoppers or hide it, then check it on your site with debug mode. - [Set up search as you type](https://releva.ai/documentation/guides/search-as-you-type/set-up-search-as-you-type.md): Connect Releva to your shop's search box under Personalization › Search As You Type, choose a results layout, set how many products to show, add a filter and switch the feature on. - [Change a segment's rules](https://releva.ai/documentation/guides/segments/change-a-segments-rules.md): Open an existing segment under Data Platform › Segments, add a filter to one of its rules and save it, and learn what a rule change does to the campaigns that use the segment. - [Create a segment](https://releva.ai/documentation/guides/segments/create-a-segment.md): Create a Behavior segment under Data Platform › Segments by naming it, adding a rule such as Added to cart, narrowing it with a Days ago filter, and checking who matches before you save. - [See who is in a segment](https://releva.ai/documentation/guides/segments/see-who-is-in-a-segment.md): Open a Behavior segment under Data Platform › Segments to read how many profiles match right now and on which channels you can reach them, page through the matching profiles, and export the full list as a file. - [Track a segment in Audience Performance](https://releva.ai/documentation/guides/segments/track-a-segment-in-audience-performance.md): Star a segment on the Segments list so Analytics › Customer Insights › Audience Performance reports its members, conversions and conversion value. - [Find your Access Token and Secret Key](https://releva.ai/documentation/guides/shop-settings/find-your-api-keys.md): Open Settings › Shop & Integration › General and copy the two keys that identify your shop to Releva. - [Schedule a full catalog sync](https://releva.ai/documentation/guides/shop-settings/schedule-a-catalog-sync.md): Set the catalog sync type, the endpoint or feed URL and a cron schedule on Settings › Shop & Integration › Catalog Sync, then test and save. - [Turn on the Releva app embed in Shopify](https://releva.ai/documentation/guides/shop-settings/turn-on-the-shopify-app-embed.md): Use the Get started with Releva page to open your Shopify theme editor, switch the Releva.ai app embed on and save the theme. - [Create an SMS](https://releva.ai/documentation/guides/sms/create-an-sms.md): Write and save an SMS (text message) draft under Marketing Channels › SMS / Text Messages, personalise it with merge tags, check its length and preview, and choose what happens when a customer hits the daily limit. - [Send an SMS with a workflow](https://releva.ai/documentation/guides/sms/send-an-sms-with-a-workflow.md): Open a saved SMS under Marketing Channels › SMS / Text Messages, select Send, and start a one-off, continuous or triggered workflow with the SMS already connected to Start, or add it to an existing workflow. - [Check how a story performs](https://releva.ai/documentation/guides/stories/check-how-a-story-performs.md): Read a story's impressions, slide views, clicks, conversions, purchases and revenue on the Stories list, then open its Statistics page to see the day-by-day chart and the products bought after a story click. - [Create a story](https://releva.ai/documentation/guides/stories/create-a-story.md): Build a tap-through story under Personalization › Stories, choose the page and audience, set when it appears and switch it on. - [Create a survey](https://releva.ai/documentation/guides/surveys/create-a-survey.md): Build a survey under Data Platform › Surveys with the drag-and-drop designer, turn on the public link so anyone with the link or a QR code can answer, and save it. - [Create an NPS survey](https://releva.ai/documentation/guides/surveys/create-an-nps-survey.md): Set up a Net Promoter Score survey under Data Platform › NPS, choose its question, colours and triggers, activate it so the Releva SDK shows it on your site, and read the score in Analytics. - [Delete a segment sync](https://releva.ai/documentation/guides/sync-segments/delete-a-segment-sync.md): Remove a segment sync from Data Platform › Sync Segments, and know what happens to the audience on Facebook or Google. - [Sync a segment to Google or Facebook](https://releva.ai/documentation/guides/sync-segments/sync-a-segment-to-google-or-facebook.md): Create a segment sync under Data Platform › Sync Segments so a behavior segment is pushed to Google Analytics 4 or to a Meta custom audience and kept up to date, with an optional Facebook lookalike audience. - [Turn a segment sync on or off](https://releva.ai/documentation/guides/sync-segments/turn-a-segment-sync-on-or-off.md): Use the switch on a sync's card under Data Platform › Sync Segments to pause or resume updates to the audience on the ad platform. - [Connect TikTok to Releva](https://releva.ai/documentation/guides/tiktok/connect-tiktok-to-releva.md): Connect a TikTok For Business account under Settings › TikTok so Releva can send your store's events to a TikTok pixel from its servers. - [Send your store's events to TikTok](https://releva.ai/documentation/guides/tiktok/send-your-stores-events-to-tiktok.md): Choose the TikTok ad account and pixel under Settings › TikTok, turn on Backend Tracking and pick which standard events Releva sends from its servers. - [Create a transactional Viber message](https://releva.ai/documentation/guides/viber/create-a-transactional-viber-message.md): Create a Transactional Viber message under Marketing Channels › Viber Messages and prepare its Viber template, so that Viber bills it as transactional instead of promotional. - [Create a Viber message](https://releva.ai/documentation/guides/viber/create-a-viber-message.md): Create a Marketing Viber message under Marketing Channels › Viber Messages, write the text, check the preview, choose what happens at the daily limit and save it as a draft for workflows. - [Create a webhook](https://releva.ai/documentation/guides/webhooks/create-a-webhook.md): Create a Standard webhook under Marketing Channels › Webhooks by naming it, entering the URL that receives the data, choosing what happens at the daily limit, and saving it so a workflow can send it. - [Send data in your receiver's format](https://releva.ai/documentation/guides/webhooks/send-data-in-your-receivers-format.md): Switch a webhook under Marketing Channels › Webhooks to the Custom type, choose the request method and format, add a header, and map body fields to profile merge tags so a third-party endpoint receives exactly the fields it expects. - [Connect WhatsApp through a Business Solution Provider](https://releva.ai/documentation/guides/whatsapp/connect-whatsapp-through-a-business-solution-provider.md): Connect your WhatsApp Business Account to Releva under Settings › Facebook & Whatsapp with the auth token, WhatsApp Business Account ID and WhatsApp Phone Number ID from your Business Solution Provider (BSP). - [Connect WhatsApp with WhatsApp Manager](https://releva.ai/documentation/guides/whatsapp/connect-whatsapp-with-whatsapp-manager.md): Connect your WhatsApp Business Account to Releva through Meta's embedded sign-up under Settings › Facebook & Whatsapp, register your phone number with a 6-digit PIN, and disconnect it again. - [Create a WhatsApp template message](https://releva.ai/documentation/guides/whatsapp/create-a-whatsapp-template-message.md): Create a text-based WhatsApp template under Marketing Channels › WhatsApp Messages, add a header, message, merge tags and footer, choose the daily-limit behaviour and submit it to Meta for approval. - [Send a WhatsApp template with a workflow](https://releva.ai/documentation/guides/whatsapp/send-a-whatsapp-template-with-a-workflow.md): Open an approved template under Marketing Channels › WhatsApp Messages, select Send, create a one-off, continuous or triggered workflow with the template connected to Start, choose the segment, save the workflow and launch it. - [Change the steps of a workflow](https://releva.ai/documentation/guides/workflows/change-the-steps-of-a-workflow.md): Open a saved workflow under Workflows › Continuous, change a Wait step's duration and a message step's send days on the canvas, adjust the repeat-entry cooldown and save. - [Create a continuous workflow](https://releva.ai/documentation/guides/workflows/create-a-continuous-workflow.md): Build a workflow under Workflows › Continuous that runs for every profile entering a Behavior segment, set repeat entry and the launch options, save it, then switch it on. - [Create a one-off workflow](https://releva.ai/documentation/guides/workflows/create-a-one-off-workflow.md): Build a one-off workflow under Workflows › One Off by naming it, adding steps on the canvas, choosing a scope and segment, setting the launch options and saving it ready to launch. - [Create a triggered workflow](https://releva.ai/documentation/guides/workflows/create-a-triggered-workflow.md): Build a workflow under Workflows › Triggered that starts when a customer performs an event, such as Cart Checkout Completed, or when your system calls its webhook, then save it and switch it on. - [Connect your Android app](https://releva.ai/documentation/integrations/android-kotlin/connect-your-android-app.md): Add the Releva Kotlin SDK from JitPack, initialise the client with your Access Token, extend the SDK's Firebase messaging service, handle navigation, track screens with page tokens and check in Releva that data arrives. - [Check that your store data arrives](https://releva.ai/documentation/integrations/check-that-your-store-data-arrives.md): After you connect any shop platform, confirm in the Releva admin that your storefront sends events, that your products are in the catalog with images and prices, and that your customers appear as profiles with their events. - [Connect your CloudCart store](https://releva.ai/documentation/integrations/cloudcart/connect-your-cloudcart-store.md): Add the Releva SDK and the CloudCart tracking snippet in Custom CSS/JS, fill in your Access Token and page tokens, and check in Releva that page views and products arrive. - [Connect your CS-Cart store](https://releva.ai/documentation/integrations/cs-cart/connect-your-cs-cart-store.md): Install the Releva AI add-on in CS-Cart, enter your Secret Key on its Settings tab, and check in Releva that the catalog sync and page views work. - [Connect your custom website](https://releva.ai/documentation/integrations/custom-website/connect-your-custom-website.md): Add the Releva JavaScript SDK to a shop on your own stack, send the page context on every page, call the catalog and order APIs from your server, and check in the Releva admin that page views, visitors and products arrive. - [JavaScript SDK reference](https://releva.ai/documentation/integrations/custom-website/javascript-sdk-reference.md): The Releva.push() signature and options, every field of the context object, what each field records, the other public functions, the endpoints the SDK calls and the cookies it sets. - [Connect your Flutter app](https://releva.ai/documentation/integrations/flutter/connect-your-flutter-app.md): Add the releva_sdk package, set up Firebase with flutterfire, initialise the client with your Access Token, register the push token, handle taps, track screens with page tokens and check in Releva that data arrives. - [Connect your GombaShop or Shopiko store](https://releva.ai/documentation/integrations/gombashop/connect-your-gombashop-store.md): Paste the Releva snippet in the GombaShop CMS, fill in your Access Token and page tokens, create a CMS user for Releva's catalog connector, and check in Releva that data arrives. - [Connect your iOS app](https://releva.ai/documentation/integrations/ios-swift/connect-your-ios-app.md): Add the Releva Swift SDK with Swift Package Manager, initialise the client with your Access Token, register the FCM token with a token provider, handle taps and silent inbox pushes, track screens with page tokens and check in Releva that data arrives. - [Swift SDK reference](https://releva.ai/documentation/integrations/ios-swift/sdk-reference.md): RelevaSDK for iOS at a glance: client and configuration presets, identity, tracking methods and the PushRequest builder, push token handling, navigation notifications, engagement events, inbox and on-screen views, and the errors to expect. - [Connect your Magento 1 store](https://releva.ai/documentation/integrations/magento/magento-1.md): Upload the Releva module through Magento Connect Manager, paste your Secret Key in the store view scope, flush the cache and check in Releva that your shop is connected. - [Connect your Magento 2 store](https://releva.ai/documentation/integrations/magento/magento-2.md): Install the Releva module for Magento 2, paste your Secret Key per store view, switch on web push and the consent cookie, and check in Releva that data arrives. - [Install the Releva app on MerchantPro](https://releva.ai/documentation/integrations/merchantpro/install-the-releva-app.md): Install Releva from the MerchantPro App Store with all permissions on, then finish the Get started with Releva wizard and start your trial. - [Add your Firebase credentials for app push](https://releva.ai/documentation/integrations/mobile/add-firebase-credentials-for-app-push.md): Upload the Firebase service account Releva sends Android and iOS app push through, choose Unified or Separate credentials and set the iOS APNs environment on Settings › Messaging › Push Notifications. - [Check that your mobile app is connected](https://releva.ai/documentation/integrations/mobile/check-that-your-mobile-app-is-connected.md): Confirm in the Releva admin that your Firebase credentials are saved, that the app's push token registrations arrive as Push Notification Subscribe events, and that the shopper's profile shows App push Subscribed with an IOS or ANDROID badge. - [Mobile SDKs overview](https://releva.ai/documentation/integrations/mobile/mobile-sdks-overview.md): Which Releva SDK to use for React Native, Expo, iOS, Android and Flutter apps, the four things you set up in the Releva admin, what every SDK sends to Releva and what still has to come from your backend. - [Connect your OpenCart store](https://releva.ai/documentation/integrations/opencart/connect-your-opencart-store.md): Install the Releva module in OpenCart, paste your Access Token, Secret Key and page tokens, set the consent cookie, and check in Releva that page views, products and customers arrive. - [Embed Releva in your platform](https://releva.ai/documentation/integrations/partner/embed-releva-in-your-platform.md): What a platform or agency implements to provision Releva shops for its merchants with the Partner API, store their keys, sign merchants into the Releva admin, keep catalog, customers and orders in sync, and check that data arrives. - [Connect your PrestaShop store](https://releva.ai/documentation/integrations/prestashop/connect-your-prestashop-store.md): Upload the Releva module in PrestaShop, paste your Secret Key, set the consent cookie, and check in Releva that page views, products and customers arrive. - [Connect your React Native app](https://releva.ai/documentation/integrations/react-native/connect-your-react-native-app.md): Install @releva-ai/sdk-react-native with Firebase messaging and notifee, initialise the client with your Access Token, register the push token, track screens with page tokens and check in Releva that data arrives. - [Push notifications with Expo](https://releva.ai/documentation/integrations/react-native/push-notifications-with-expo.md): Set up Releva push in a React Native app that uses Expo and expo-notifications, with the Expo adapter of @releva-ai/sdk-react-native, APNs token registration for iOS and the iOS APNs environment setting in Releva. - [React Native SDK reference](https://releva.ai/documentation/integrations/react-native/sdk-reference.md): @releva-ai/sdk-react-native at a glance: client constructor and configuration presets, identity, tracking, push, inbox and on-screen methods, the push payload and tap action, the events each call writes, and the errors to expect. - [Connect your Shopify store](https://releva.ai/documentation/integrations/shopify/connect-your-shopify-store.md): Install the Releva app from the Shopify App Store, finish the onboarding wizard, switch the Releva.ai app embed on and check that products, customers, orders and page views reach Releva. - [Use your theme's product card for Releva recommendations](https://releva.ai/documentation/integrations/shopify/use-your-themes-product-card.md): Let Releva pick the products and your Shopify theme render them, by pointing a Releva Product Block at a Liquid section of your own. - [Connect your WooCommerce store](https://releva.ai/documentation/integrations/woocommerce/connect-your-woocommerce-store.md): Install the Releva.ai Integration plugin on WordPress, paste your Access Token, Secret Key and page tokens, and check that products, customers and events arrive in Releva. - [Copy your page tokens for the WooCommerce plugin](https://releva.ai/documentation/integrations/woocommerce/copy-your-page-tokens.md): Find the token of each Releva page on Personalization › Product Blocks and paste it into the matching page-token field of the Releva.ai Integration plugin. - [All endpoints](https://releva.ai/documentation/reference/all-endpoints.md): 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. - [Campaigns API overview](https://releva.ai/documentation/reference/campaigns/overview.md): Run a webhook-triggered campaign or workflow from your own system with POST /api/v0/campaigns/{id}/runs: authentication, request body, custom fields as merge tags, responses, errors and limits. - [Create or update products](https://releva.ai/documentation/reference/catalog/create-or-update-products.md): POST /api/v0/products: send new and changed products to Releva, with variants, languages, currencies and markets, custom fields, a field table, a working curl, responses, errors and limits. - [Delete a product](https://releva.ai/documentation/reference/catalog/delete-a-product.md): DELETE /api/v0/products/{id}: remove a product from Releva's catalog for good, with a working curl, the response, errors and limits. - [Let Releva pull your catalog](https://releva.ai/documentation/reference/catalog/let-releva-pull-your-catalog.md): The catalog endpoint you build for a full sync: the request Releva sends, the response you return, paging, retries, deletion, triggers, default URLs per platform, and POST /api/v0/products/sync. - [Catalog API overview](https://releva.ai/documentation/reference/catalog/overview.md): The catalog calls, one page each, and the authentication, request format, responses and limits they share. - [Update product availability](https://releva.ai/documentation/reference/catalog/update-product-availability.md): POST /api/v0/products/availability: change only whether products can be bought, with the request, a working curl, responses, errors and limits. - [Create or update companies](https://releva.ai/documentation/reference/companies/create-or-update-companies.md): POST /api/v0/companies: create or replace the B2B companies of your shop from your server, with the company field table, a working request and the errors. - [Delete a company](https://releva.ai/documentation/reference/companies/delete-a-company.md): DELETE /api/v0/companies/{companyId}: delete one B2B company of your shop from your server. Its roles are kept. - [Link profiles to companies](https://releva.ai/documentation/reference/companies/link-profiles-to-companies.md): POST /api/v0/roles: link customer profiles to B2B companies with a role, from your server. Creates the profiles when they do not exist. - [B2B API overview](https://releva.ai/documentation/reference/companies/overview.md): The company and role calls of the Releva API, one page each (create or update companies, delete a company, link profiles to companies, remove a profile from a company). - [Remove a profile from a company](https://releva.ai/documentation/reference/companies/remove-a-profile-from-a-company.md): DELETE /api/v0/roles/{companyId}/{emailOrPhone}: unlink one profile from one B2B company, from your server. The profile and the company are kept. - [Check an email's consent history](https://releva.ai/documentation/reference/consent/check-consent-history.md): POST /api/v0/subscribe/check with your access token tells you whether an email address has ever been subscribed or unsubscribed in your shop. Request, curl, Releva.checkSubscribed, response, errors and the 30-per-15-minutes limit. - [Choose a consent call](https://releva.ai/documentation/reference/consent/choose-a-consent-call.md): A decision table for every way a customer gets subscribed or unsubscribed in Releva (server API, browser API, SDK, admin buttons, email links, the List-Unsubscribe header), with the key each needs and what it changes. - [Consent API overview](https://releva.ai/documentation/reference/consent/overview.md): The consent and subscription calls of the Releva API, one page each - subscribe from your server or the browser, double opt-in, unsubscribe, unsubscribe links and one-click, and consent history. - [Set up double opt-in](https://releva.ai/documentation/reference/consent/set-up-double-opt-in.md): Make sign-ups from your site wait for an email confirmation. Set Wait for confirmation, send subscribe requests, trigger a workflow on Subscribe Request Submitted, put {{subscribeLink}} in the email, and check the confirmation page. - [Subscribe a customer from your server](https://releva.ai/documentation/reference/consent/subscribe-a-customer.md): POST /api/v0/subscribe with your secret key subscribes a customer to marketing messages right away and replaces, adds or removes their subscriptions. Fields, curl, response, errors and limits. - [Subscribe a customer from the browser](https://releva.ai/documentation/reference/consent/subscribe-from-the-browser.md): POST /api/v0/subscribe/request with your access token sends a sign-up from your site. Depending on your shop setting it subscribes right away (200) or waits for an email confirmation (202). Fields, curl, Releva.requestSubscribe, errors and limits. - [Unsubscribe a customer with the API](https://releva.ai/documentation/reference/consent/unsubscribe-a-customer.md): POST /api/v0/unsubscribe with your secret key opts a customer out of marketing messages by email address or phone number. Fields, curl, the External mode flow, response, errors and limits. - [Unsubscribe links and one-click unsubscribe](https://releva.ai/documentation/reference/consent/unsubscribe-links-and-one-click.md): What {{unsubscribeLink}}, {{subscriptionManagementLink}} and the List-Unsubscribe header do in Internal and External mode, the subscription preferences page, and the RFC 8058 one-click endpoint POST /api/v0/unsubscribe/oneclick/{payload}. - [Events API overview](https://releva.ai/documentation/reference/events/overview.md): The events calls, one page each, and the authentication, request format, responses and limits they share. - [Read events](https://releva.ai/documentation/reference/events/read-events.md): GET /api/v0/events: read your shop's events, newest first, 10 per page, with the query parameters, paging, a working curl, the response and errors. - [Send custom events](https://releva.ai/documentation/reference/events/send-custom-events.md): POST /api/v0/events: record events from your backend on a customer's profile, with the field table, a working curl, responses, errors and limits. - [Send events from the browser](https://releva.ai/documentation/reference/events/send-events-from-the-browser.md): Custom events with Releva.push and the access token: the event fields, a working example, the raw POST /api/v0/push/{accessToken} call, responses and errors. - [Send search events](https://releva.ai/documentation/reference/events/send-search-events.md): POST /api/v0/search: record a search or filtered listing from your backend in a shopper's history, with the filter grammar, a working curl, responses, errors and limits. - [Authentication, errors and limits](https://releva.ai/documentation/reference/get-started/authentication-errors-and-limits.md): The rules every Releva API call shares. The base URL, which key to send (Access Token or Secret Key), the request format and 800 KB body limit, status codes and error messages, rate limits and versioning. - [Build your integration](https://releva.ai/documentation/reference/get-started/build-your-integration.md): What a developer builds to connect a shop to Releva, in order. Get the keys, install Releva on your platform, send the catalog and orders, handle consent, then check that the data arrives. - [Inbox API overview](https://releva.ai/documentation/reference/inbox/overview.md): The six endpoints a mobile app uses to read a shopper's App Inbox: authentication with the access token, the userId rule, pagination, read and delete semantics, errors and limits, with a working request for each. - [Orders and refunds API overview](https://releva.ai/documentation/reference/orders/overview.md): The order calls, one page each, and the authentication, request format, responses and limits they share. - [Report paid orders](https://releva.ai/documentation/reference/orders/report-paid-orders.md): POST /api/v0/carts: report every paid order to Releva, with the field table, a working curl, responses, errors and limits. - [Report refunds](https://releva.ai/documentation/reference/orders/report-refunds.md): POST /api/v0/refunds: take refunded money out of an order's revenue, by line items or by amount, with a working curl, responses, errors and limits. - [Send order status updates](https://releva.ai/documentation/reference/orders/send-order-status-updates.md): The orderStatusChanged event on POST /api/v0/events: tell Releva where an order is after payment, with the status fields, which platforms send it, how cancellations and Sales Agent answers use it, a working curl and errors. - [Partner API overview](https://releva.ai/documentation/reference/partners/overview.md): The endpoints a platform or agency uses to provision and manage Releva accounts for its merchants: partner token and signed payload authentication, shop lookup, provisioning, pausing, plans, billing periods, uninstall, usage charges, profiles, the single sign-on link, errors and limits, with a working request for each. - [Build the subscriber sync endpoint](https://releva.ai/documentation/reference/profiles/build-the-subscriber-sync-endpoint.md): The endpoint your shop exposes so Releva can pull your subscriber list: request, paging, the subscriber fields and subscribedAt semantics, plus POST /api/v0/subscribers/sync to start a pull. - [Create or update profiles](https://releva.ai/documentation/reference/profiles/create-or-update-profiles.md): POST /api/v0/profiles: create or update customer profiles in bulk from your server (backfill and custom integrations), with the Profile object field table and how to send subscription data. - [Delete a profile](https://releva.ai/documentation/reference/profiles/delete-a-profile.md): DELETE /api/v0/profiles: delete a customer profile and the profiles merged into it, by id, email or phone number, from your server. - [Export a profile's data](https://releva.ai/documentation/reference/profiles/export-a-profiles-data.md): POST /api/v0/profiles/exports: e-mail a download link with everything Releva holds about one person (profile, devices, events, attribution), for a data access request. - [Get a loyalty link](https://releva.ai/documentation/reference/profiles/get-a-loyalty-link.md): GET /api/v0/loyalty-link: get the personal loyalty page link of a profile by email or phone number, from your server, to show a My points link on your own site. - [Get a profile](https://releva.ai/documentation/reference/profiles/get-a-profile.md): GET /api/v0/profiles: read one customer profile by id, email or phone number from your server, with every field of the response. - [Profiles API overview](https://releva.ai/documentation/reference/profiles/overview.md): The profile calls of the Releva API, one page each (create or update, get, delete, export, register, the subscriber sync and the loyalty link), plus how profiles are identified. - [Record a registration](https://releva.ai/documentation/reference/profiles/record-a-registration.md): POST /api/v0/register: tell Releva that a customer created an account in your shop, from your server. Creates or updates the profile and stamps the registration time. - [Push notifications API overview](https://releva.ai/documentation/reference/push-notifications/overview.md): How a browser or mobile app registers for Releva push notifications: the web SDK setup, the two registration endpoints, authentication with the access token, errors and limits. - [Endpoints the Releva SDKs call](https://releva.ai/documentation/reference/sdk/endpoints-the-releva-sdks-call.md): The storefront and app endpoints the Releva JavaScript and mobile SDKs call, and the product blocks, banners and stories they receive in the page push, with the click, impression and event calls that report back. For teams that build their own client. - [Search as you type API overview](https://releva.ai/documentation/reference/search-as-you-type/overview.md): Authentication, request, response, errors and limits of POST /api/v0/searchAsYouType, plus the browser SDK functions for rendering results yourself. - [Surveys and NPS API](https://releva.ai/documentation/reference/surveys/overview.md): The three public endpoints behind Releva's hosted survey page and the NPS widget, the nps object in the page push, the SDK functions, limits and every error message, with a working request for each. - [Webhooks API overview](https://releva.ai/documentation/reference/webhooks/overview.md): What Releva sends to your webhook URL (payload, batches, authentication, retries), and the GET /webhooks/events endpoint your system calls to record webhook opens and clicks: auth, parameters, responses, errors and limits. - [What's new](https://releva.ai/documentation/whats-new.md): Monthly digests of what changed in Releva, each change with where to try it and the page that explains it, plus the RSS feed and the changelogs. - [October 2026](https://releva.ai/documentation/whats-new/2026-10.md): Releva releases in October 2026: Shopify coupons in the admin, impersonation previews across pages, banner fixes on the web, banner styling and push fixes in the iOS, React Native and Flutter SDKs. - [November 2026](https://releva.ai/documentation/whats-new/2026-11.md): Releva releases in November 2026: banners, story slides and App Inbox messages are built in Releva's own builder. - [Integrations changelog](https://releva.ai/documentation/changelog/integrations.md): Releases of the Releva JavaScript, iOS (Swift), React Native and Flutter SDKs since October 2026, dated, with what changed and the page that explains it.