--- title: "Connect Bloomreach" description: "Create an API key in Bloomreach Engagement, connect it, and create or update customers with their consents." url: https://scratcher.io/help/integrations/bloomreach language: en --- 1. [Help center](https://scratcher.io/help) 2. [Integrations](https://scratcher.io/help/integrations) 3. Connect Bloomreach # Connect Bloomreach Create an API key in Bloomreach Engagement, connect it, and create or update customers with their consents. With the Bloomreach integration, everyone who signs up is created or updated as a customer in your Bloomreach Engagement project, identified by their email address. You can also give them a Bloomreach consent, so you may send them marketing. ## What you need - A Bloomreach Engagement project, and a user who can manage API access in the project settings (usually a project administrator). ## Step 1: Create an API key in Bloomreach 1. In Bloomreach Engagement, open the project and go to **Project settings** > **Access management** > **API**. 2. Copy the **Project token** and the **API base URL** shown on the page. 3. Under the API groups, create a new group with **Private access**, and name it for example "Scratcher". 4. Create a new API key in the group. Copy the **API key ID** and the **API secret**. The secret is only shown once. 5. Give the group the permissions below and save. ## Permissions the key needs On the group's permissions, allow: - **Customer properties**: get and set, to find customers and create or update them, and to show your customer properties in the field mapping. - **Events**: set, for the `consent` event, so Scratcher can record consents. Nothing else is needed. Without the set permissions, deliveries fail with Bloomreach's own access error. ## Step 2: Connect Bloomreach to Scratcher 1. In Scratcher, go to **Settings** > **Integrations** and click **Bloomreach**. 2. Paste the API base URL, the project token, the API key ID and the API secret in the matching fields. 3. Click **Install integration**. Scratcher checks the details with Bloomreach. ## Step 3: Turn it on in a campaign 1. In the editor, go to **Connect** > **Integrations** > **Bloomreach** and click **Activate**. 2. If you have connected more than one project, choose it under **Select account**. 3. Under **Field mappings**, click **Add field mapping** and match each **Scratcher field** to a Bloomreach customer property, for example "Lead - First name" to **first\_name**. 4. Choose the consent category people should get, for example "newsletter", or none. 5. Under **Filter by permissions (optional)**, choose your marketing consent checkbox, so only people who ticked it are sent. 6. Click **Save**, and then **Test**. > Good to know: Bloomreach has no lists. Everyone goes into the project, and you group them with segments in Bloomreach. So Scratcher starts sending as soon as you click **Activate**. Activate it before the campaign goes live, or set it up right away. ## Field mapping - The email address is always sent and is used to find the customer. You don't need to map it. - The **Destination field** list shows the customer properties in your project. Create a property in Bloomreach first if it's missing. - To mark where customers came from, map a **Use custom value** such as "Scratcher summer game" to a property you use for the source. ## Consent If you choose a consent category, Scratcher records a `consent` event with the action accept and the campaign's name as the source. The category must exist in Bloomreach (under the consent settings in **Project settings**). Use **Filter by permissions** so only people who ticked your marketing checkbox get the consent. ## What is sent and when New sign-ups are sent within a minute or two. When you activate the integration, the campaign's existing leads are sent too. When someone takes part again, the customer is updated. Check every delivery under **Settings** > **Integrations** > **Delivery status**. See [Check the delivery status and resend leads](https://scratcher.io/help/integrations/delivery-status). ## Troubleshooting - "All or some of the fields are invalid..." when installing: check the API base URL and the project token, and copy the key ID and secret again. - Deliveries fail with an access error: the API group is missing a permission above. Edit it in Bloomreach. - The consent doesn't show on the customer: the consent category doesn't exist in Bloomreach, or is spelled differently. - Bloomreach has its own guides for API keys. Search Bloomreach's documentation for "API access management" if the menus look different. Integrations - [How integrations work](https://scratcher.io/help/integrations/how-integrations-work) - [All integrations](https://scratcher.io/help/integrations/other-integrations) - [Check the delivery status and resend leads](https://scratcher.io/help/integrations/delivery-status) - [Connect HubSpot](https://scratcher.io/help/integrations/hubspot) - [Connect Salesforce Marketing Cloud](https://scratcher.io/help/integrations/salesforce-marketing-cloud) - [Connect Microsoft Dynamics 365 with Zapier](https://scratcher.io/help/integrations/microsoft-dynamics-365) - [Connect Emarsys](https://scratcher.io/help/integrations/emarsys) - [Connect Klaviyo](https://scratcher.io/help/integrations/klaviyo) - [Connect Mailchimp](https://scratcher.io/help/integrations/mailchimp) - [Connect ActiveCampaign](https://scratcher.io/help/integrations/activecampaign) - [Connect Apsis One](https://scratcher.io/help/integrations/apsis-one) - [Connect Drip](https://scratcher.io/help/integrations/drip) - [Connect HeyLoyalty](https://scratcher.io/help/integrations/heyloyalty) - [Connect Peytz](https://scratcher.io/help/integrations/peytz) - [Connect Marketingplatform](https://scratcher.io/help/integrations/marketingplatform) - [Connect Campaign Monitor with Zapier](https://scratcher.io/help/integrations/campaign-monitor) - [Connect ActiveTrail with Zapier](https://scratcher.io/help/integrations/activetrail) - [Connect Bloomreach](https://scratcher.io/help/integrations/bloomreach) - [Connect Iterable](https://scratcher.io/help/integrations/iterable) - [Connect Mapp](https://scratcher.io/help/integrations/mapp) - [Connect Agillic](https://scratcher.io/help/integrations/agillic) - [Connect Ortto](https://scratcher.io/help/integrations/ortto) - [Connect Emarketeer](https://scratcher.io/help/integrations/emarketeer) - [Connect Shopify](https://scratcher.io/help/integrations/shopify) - [Connect Hello Retail](https://scratcher.io/help/integrations/hello-retail) - [Connect 8,000+ apps with Zapier](https://scratcher.io/help/integrations/zapier) - [Connect monday.com with Zapier](https://scratcher.io/help/integrations/monday-com) - [Connect Asana with Zapier](https://scratcher.io/help/integrations/asana) - [Connect Podio with Zapier](https://scratcher.io/help/integrations/podio) - [Connect Intercom with Zapier](https://scratcher.io/help/integrations/intercom) ## Related articles - [How integrations work](https://scratcher.io/help/integrations/how-integrations-work): Connect your email tool or CRM once, turn it on in each campaign, choose a list, map your fields and send only people who gave consent. - [Check the delivery status and resend leads](https://scratcher.io/help/integrations/delivery-status): See which leads were sent to your tools, understand the error messages, fix the problem and send them again. - [Ask for consent and add terms and conditions](https://scratcher.io/help/forms/consent-and-permissions): Add consent checkboxes for newsletters, link your terms, choose which checkbox subscribes people and send only people who said yes to your email tool. ## Still need help? Real people are here to help. If you already use Scratcher, the quickest way is the chat inside the platform. - **[Chat with us](https://platform.scratcher.io/login)** Log in and click the chat button in the bottom-right corner. Rex answers right away, and our team is a click away. - **[Book a meeting](https://scratcher.io/book-a-meeting)** A free 30-minute video call with our team: a tour, campaign ideas or help with your setup. - **[Email us](mailto:contact@scratcher.io)** Write to contact@scratcher.io and we will get back to you.