> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeotap.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Batch CEP
> Connect Zeotap CDP to Batch CEP with an API Bearer Token and Project Key. Send audience segments to Batch as a named audience, or use Mass Update Profiles to keep Batch profile attributes, topic preferences and events in sync.
## Overview
This integration connects Zeotap CDP to **Batch CEP** so you can power targeted mobile and customer engagement campaigns without manual file transfers. Once the destination is created and linked to an audience, Zeotap sends the data you mapped to Batch on the refresh frequency you choose.
The connector supports two outcomes, depending on the action you pick:
* **Create an audience in Batch** and populate it with the identifiers and attributes you map.
* **Update attributes on existing Batch profiles**, without creating an audience.
**Batch vs. Batch CEP**
Two Batch destinations are available in the Zeotap catalogue:
* **Batch** — the original connector. See [Batch](/articles/integrate-customer/batch).
* **Batch CEP** — a newer connector that reflects recent improvements to the Batch APIs and is recommended for new audience and profile integrations.
This page covers the **Batch CEP** connector. Confirm with your team which connector to use before starting.
## Available Actions
Both actions are chosen on the **Mapping** screen under **Choose your Action**. A destination can hold one mapping per action, so you can set up either or both.
| Action | What it does | When to use | Setup |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------- |
| **Send audiences to Batch** | Creates a named audience in Batch and populates it with the mapped identifier and any audience-level attributes. | You want a targetable audience in Batch. | [Action 1](#action-1-—-send-audiences-to-batch) |
| **Mass Update Profiles** | Updates attributes, topic preferences and events on existing Batch profiles. **Does not create an audience.** | You want to keep profile data in sync or enrich it. | [Action 2](#action-2-—-mass-update-profiles) |
The two actions write to different places: **Send audiences to Batch** writes at the **audience** level, while **Mass Update Profiles** writes to the **profile**. Attributes sent with the audience action never land on the profile — see the warning in [Action 1](#action-1-—-send-audiences-to-batch).
## Supported Identifiers
**For Send audiences to Batch** — Batch CEP supports three audience types. Pick the one that matches the identifier you are sending:
* **Custom Ids** — your own internal user IDs
* **Emails** — email addresses
* **Install Ids** — mobile app install IDs
You can also send up to **15 attributes per user** alongside the identifier.
**For Mass Update Profiles** — map at least one of the following identifiers. You may map more than one:
* **Custom ID** — your own internal user ID
* **Installation ID** — Batch installation identifier
* **Device ID** — device identifier
There is no email identifier for **Mass Update Profiles**. Email is a profile **attribute** (**Email Address**) for that action, not something Batch matches the profile on.
## How It Works
1. You set up Batch CEP as a destination in Zeotap CDP by entering your **API Bearer Token** and **Batch Project Key**.
2. You choose an action — **Send audiences to Batch** or **Mass Update Profiles** — and configure the **field mapping** for it.
3. For **Send audiences to Batch** only, you set the **Audience Type** (`Custom Ids`, `Emails`, or `Install Ids`) so it matches the identifier you are sending.
4. You **link the destination to a segment** in Zeotap and choose a refresh frequency.
5. Once linked, Zeotap sends the data on that cadence:
* **Send audiences to Batch** — Zeotap creates the audience in Batch and populates it with the identifiers and attributes you mapped, splitting large audiences into batches automatically.
* **Mass Update Profiles** — Zeotap updates the mapped attributes on matching Batch profiles. No audience is created.
## Prerequisites
Make sure you have everything ready before starting the setup.
**In Batch:**
* An active Batch account with access to the Batch dashboard.
* Your **REST API Key** (also called API Bearer Token) — visible to account managers under **Account Settings → Custom Settings**. Keep this value secret and never expose it in client applications.
* Your **Project Key** — found in the Batch project settings.
* *(Send audiences to Batch only)* A clear understanding of which **audience type** you will use — `Custom Ids`, `Emails`, or `Install Ids` — based on the identifier you plan to send.
**In Zeotap CDP:**
* Access to the **Integrate** module with permission to create new destinations.
* An audience segment ready to send to Batch.
* The identifier you intend to send, and any attributes you want to include:
* For **Send audiences to Batch** — an email, custom ID or install ID.
* For **Mass Update Profiles** — at least one of Custom ID, Installation ID or Device ID that exists on your Batch profiles.
The REST API Key authenticates every request and is visible only to account managers. Treat it like a password and never share it in client-side code, screenshots, or chat messages.
## Get Your Credentials from Batch
Before connecting Zeotap to Batch, collect two values from your Batch project: the **REST API Key** and the **Project Key**.
Log in to your **Batch** account. Click your profile avatar at the top right and select **Account settings**.
Open your project, then go to **Settings → General**. The **App settings** card shows your **REST API Key** (click the eye icon to reveal it) and your **Project Key**. Copy both values somewhere secure — you will paste them into Zeotap shortly.
You should now have:
* **REST API Key** (used as the API Bearer Token in Zeotap)
* **Project Key**
## Create the Batch CEP Destination in Zeotap CDP
### Enter your Batch credentials
Log in to **Zeotap CDP** and go to **Integrate → Destinations**. Click **+ Create Destination** and search for **Batch** in the catalogue. Two cards appear — **Batch** and **Batch CEP**. Select the **Batch CEP** card.
Fill in the configuration fields:
* **Destination Name** — a descriptive label (e.g., `Batch — Q2 Mobile Audience Sync`).
* **API Bearer Token** — paste the REST API Key you copied from Batch.
* **Project Key** — paste the Project Key you copied from Batch.
Click **Next** to proceed to the **Mapping** screen, where you choose the action.
A destination can hold one mapping per action, so you can come back later and add the second one. The save button differs by entry point: it reads **Create Destination** when you are creating the destination with its first mapping, and **Save Mapping** when you are adding a mapping to a destination that already exists.
### Action 1 — Send audiences to Batch
Use this action when you want a named, targetable audience in Batch.
On the **Mapping** screen:
1. Under **Choose your Action**, select **Send audiences to Batch**.
2. Under **Map the Fields**, map your identifier and any attributes:
* The **ID** field is the identifier each user will be added to the Batch audience under (e.g., **Email Raw** → `Id`).
* Optional **Attributes** are extra fields sent alongside the ID (e.g., **Last Name** → `last_name`, **Age** → `age`).
You can map up to **15 attributes per user**. Attributes are useful for personalising campaigns inside Batch — for example, addressing recipients by first name.
**Attributes sent with this action are audience-level, not profile-level.** Attributes sent through the Audience API are not appended to user profiles. They live at the audience level as *rich audience* attributes — tied to that specific audience, not merged into the profile. They do not appear as profile attributes and cannot be used as filters in Segment or Query Builder targeting.
Rich audience attributes are meant for personalisation, not segmentation. Once the audience is added to your orchestration targeting, call the attributes in the message body with `audienceAttribute(audience_code)`.
If you need the attributes on the profile itself, use [Mass Update Profiles](#action-2-—-mass-update-profiles) instead.
Scroll to **Additional Settings** and pick the **Audience Type** that matches the identifier you mapped above:
| Identifier you are sending | Audience Type to select |
| -------------------------- | ----------------------- |
| Email addresses | **Emails** |
| Your own internal user IDs | **Custom Ids** |
| Mobile app install IDs | **Install Ids** |
The **Audience Type must match the identifier you map**. If you send emails into a `Custom Ids` audience (or vice versa), Batch rejects the records or creates an audience that cannot be activated. Always double-check this before saving.
Review every value you entered:
* Destination name
* API Bearer Token and Project Key
* Action: **Send audiences to Batch**
* Field mapping (ID + any attributes)
* Audience Type matches the ID you are sending
Click **Create Destination**. The destination now appears under **Audiences → Destinations**, ready to link.
### Action 2 — Mass Update Profiles
Use this action to update attributes on **existing** Batch profiles — to keep profile data in sync or to enrich it. Unlike *Send audiences to Batch*, this action **does not create an audience**.
On the **Mapping** screen, under **Choose your Action**, select **Mass Update Profiles**.
Under **Identifiers**, map at least one of **Custom ID**, **Installation ID** or **Device ID**. You can map more than one.
At least one identifier is required — it is what Batch matches the profile on. A mapping with attributes but no identifier cannot be applied.
Under **Attributes**, map the profile fields you want to keep in sync. All attributes are optional.
**Two fields need special date formatting: Birthday and Zeotap Date.** These are the only fields with this requirement. They use an internal format (for example `date(birthday)`) and are ingested into Batch as timestamps, so supply values in ISO 8601 UTC — for example `2012-08-12T22:30:05Z`. No other field needs this formatting.
The **Attributes** section lists the profile fields the connector exposes.
Under **Topic Preference**, map a catalogue attribute to the **Add** field to subscribe profiles to a topic. The section is repeatable — click **+ Add Mapping Field** to add more rows.
To send events into Batch as well:
* Under **Events**, map the event **Name**.
* Under **Event Attributes**, map **Label** (String) and **Tags** (List).
Click **Save Mapping**, then link the destination to your audience using the same flow as Action 1 — see [Link a Segment to the Batch CEP Destination](#link-a-segment-to-the-batch-cep-destination) and Figures 11 and 12. Once processing finishes, the profile updates are applied in Batch.
**Want both profile updates and an audience?** Run **Mass Update Profiles** first, then **Send audiences to Batch** on the same audience. Each action lives in its own mapping on the same destination, so you can link both.
## Link a Segment to the Batch CEP Destination
With the destination created, link it to an audience segment so Zeotap starts sending data.
In Zeotap CDP, navigate to **Segment → Audiences**. Find the audience you want to send, click the three-dots (⋮) icon next to it, and select **Link to Destination**.
On the linking screen:
1. Choose the **Batch CEP** destination you created from the destination list on the right.
2. Pick the **mapping** to apply to this audience. The mapping you choose determines which action runs — the one built for *Send audiences to Batch* or the one built for *Mass Update Profiles*. If you set up both, you can link both mappings.
3. Pick a **refresh frequency** that suits your use case (e.g., one-time, scheduled, or continuous).
4. Click **Save Destination**, then save the segment setup.
For more on linking audiences in general, see [Link an Audience to the Destination](/articles/integrate-customer/link-an-audience-to-the-destination).
## Field Mapping Reference
### Send audiences to Batch
| Zeotap CDP field | Maps to (Batch) | Required / Optional | Notes |
| ----------------------------- | ------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Audience Name (set by Zeotap) | `name` | **Required** | The name Batch uses to identify the audience. Letters, numbers, underscores (`_`), and hyphens (`-`) only. Maximum 255 characters. **Case-sensitive.** |
| Audience Display Name | `display_name` | Optional | Human-readable description shown in Batch. |
| Audience Type | `type` | **Required** | Must be one of `custom_ids`, `emails`, or `install_ids`, and must match the identifier you map. |
| Mapped ID field | audience identifier | **Required** | The user identifier each record is added under (e.g., email, custom user ID, install ID). |
| Mapped attribute fields | audience-level (*rich audience*) attributes | Optional | Up to **15 attributes per user**. These are not written to user profiles — see the warning in Action 1. |
### Mass Update Profiles
**Identifiers** — map at least one; you may map several:
| Destination field | Type | Required / Optional | Notes |
| ----------------- | ------ | --------------------- | ------------------------------ |
| Custom ID | String | At least one required | Your own internal user ID. |
| Installation ID | String | At least one required | Batch installation identifier. |
| Device ID | String | At least one required | Device identifier. |
**Attributes** — all optional. The following are visible on the mapping screen:
| Destination field | Type | Notes |
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------- |
| Customer Tier | String | |
| Zeotap Date | String | Needs ISO 8601 UTC formatting — see the date warning in Action 2. Can be used as a refresh timestamp. |
| Firstname | String | |
| Lastname | String | |
| Email Address | String | Profile email. For this action email is an attribute, not an identifier. |
| Email Marketing | String | |
| Phone Number | String | |
The attribute list continues past **Phone Number**. Other profile fields commonly available include **Region**, **Timezone**, **Birthday / Date of birth** (needs the same ISO 8601 UTC formatting as Zeotap Date), **Interests**, and any custom attributes configured on your Batch project.
Confirm the full attribute list in your own workspace — the fields the connector exposes depend on your Batch project configuration.
**Topic Preference, Events, and Event Attributes** — all optional:
| Section | Destination field | Type | Notes |
| ---------------- | ----------------- | ------ | ------------------------------------------------------------ |
| Topic Preference | Add | String | Repeatable — use **+ Add Mapping Field** to map more topics. |
| Events | Name | String | The name of the event to send into Batch. |
| Event Attributes | Label | String | Attribute associated with the event. |
| Event Attributes | Tags | List | List of tags associated with the event. |
## Activate and Test the Integration
Once the segment is linked and saved, verify the data has reached Batch.
Zeotap encrypts and sends the data to Batch in the background, based on the refresh frequency you chose.
Log in to **Batch**, then go to **Data → Audiences**. The audience you sent from Zeotap appears in the list. Open it and check the identifier count — it should match (or closely match) the number of users in your Zeotap segment.
In the example walkthrough, an audience of approximately **5,000 identifiers** appeared in Batch shortly after the sync completed.
No audience is created by this action, so verify at the profile level instead: in Batch, look up a user you know was in the linked segment and confirm the attributes you mapped now appear on that profile.
A successful integration looks like this: for **Send audiences to Batch**, your audience appears in Batch under **Data → Audiences** with the expected identifier count and the correct audience type, ready for campaign targeting. For **Mass Update Profiles**, the mapped attributes appear on the matching Batch profiles.
Batch processes audience data **asynchronously**. After a successful send, Batch returns an `indexing_token` and processes the records in the background — usually in real time, but no SLA is guaranteed. If counts do not appear immediately, wait a few minutes and refresh the audience view.
## Important Notes & Limitations
**Send audiences to Batch**
**Audience Type must match the identifier.** If you send emails into a `Custom Ids` audience (or vice versa), Batch rejects the records. Always confirm the audience type before saving the destination.
**Audience names are case-sensitive and have character restrictions.** Only letters (a–z, A–Z), numbers (0–9), underscores (`_`), and hyphens (`-`) are allowed, with a maximum of 255 characters. Names with special characters, spaces, or accents will fail.
**Batching is automatic.** Each Update request to Batch supports up to **10,000 IDs**. For audiences larger than 10,000, Zeotap automatically splits the payload into multiple sequential requests against the same audience name — you do not need to do anything.
**Maximum 15 attributes per user.** If you map more than 15 attributes, the additional ones are not sent.
**Attributes stay at the audience level.** They are not merged into user profiles and cannot be used as segmentation filters. If you need attributes on the profile, use **Mass Update Profiles** instead.
**Mass Update Profiles**
**No audience is created.** This action only updates existing Batch profiles. Use *Send audiences to Batch* if you need a targetable audience.
**At least one identifier is required** — Custom ID, Installation ID or Device ID. It is what Batch matches the profile on.
**Birthday and Zeotap Date need ISO 8601 UTC formatting** (for example `2012-08-12T22:30:05Z`). They are the only two fields with a special date-format requirement.
**Audience Type, the 15-attribute cap and the 10,000-ID batching rule do not apply to this action.** They are limits of the Batch Audience API, which this action does not use.
## Support
If you run into issues during setup or have questions about the Zeotap-to-Batch CEP integration, reach out to your Zeotap account manager or contact the Zeotap support team.