Skip to main content

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.

​
Overview

This integration sends audience segments from Zeotap CDP directly into 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 automatically creates a named audience in Batch and populates it with the user identifiers and attributes you map. You configure the connection, map your fields, link it to your segment, and Zeotap handles the rest — including batching for large audiences.
Batch vs. Batch CEPTwo Batch destinations are available in the Zeotap catalogue:
  • Batch — the original connector. See Batch.
  • Batch CEP — a newer connector that reflects recent improvements to the Batch APIs and is recommended for new audience integrations.
This page covers the Batch CEP connector. Confirm with your team which connector to use before starting.

​
Supported Identifiers

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 (e.g., first name, last name, age) alongside the identifier.

​
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 select the Send audiences to Batch action and configure the field mapping — telling Zeotap which identifier and attributes to send.
  3. You set the Audience Type in Batch (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 creates the audience in Batch and populates it with the user identifiers and any attributes you mapped — splitting large audiences into batches automatically.

​
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.
  • 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 user identifier you intend to send (e.g., email, custom ID, install ID) and any attributes you want to include.
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.
1

Open Batch Account Settings

Log in to your Batch account. Click your profile avatar at the top right and select Account settings.
Batch dashboard with the profile dropdown open showing Account settings highlighted.
2

Copy the Project Key and REST API Key

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.
Batch project settings page showing Project name, REST API key, Live API Key, and Project key fields.
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

1

Open the Destinations catalogue

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.
Zeotap Integrate Destinations catalogue showing Batch and Batch CEP cards.
2

Enter the destination details

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 action and field mapping.
3

Choose the action and map the fields

On the Mapping screen:
  1. Under Choose your Action, select Send audiences to Batch — the only action available for this connector.
  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 profile fields sent alongside the ID (e.g., Last Name → last_name, Age → age).
Zeotap mapping screen showing Last Name, Age (Integer) and Email Raw mapped to last_name, age, and Id.
You can map up to 15 attributes per user. Attributes are useful for personalising campaigns inside Batch — for example, addressing recipients by first name or segmenting further by age.
4

Set the Audience Type to match your identifier

Scroll to Additional Settings and pick the Audience Type that matches the identifier you mapped above:
Identifier you are sendingAudience Type to select
Email addressesEmails
Your own internal user IDsCustom Ids
Mobile app install IDsInstall Ids
In the example below, Email Raw is being sent, so the audience type is set to Emails.
Additional Settings section in Zeotap with Audience Type dropdown.
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.
5

Review and create the destination

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.
Mapping summary view with Send audiences to Batch action and last_name mapped under Map the Fields.
With the destination created, link it to an audience segment so Zeotap starts populating Batch.
1

Open the segment’s link menu

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.
Audiences list with a segment row’s three-dots menu open showing Link to Destination.
2

Select the Batch CEP destination, mapping, and refresh frequency

On the linking screen:
  1. Choose the Batch CEP destination you just created from the destination list on the right.
  2. Pick the mapping to apply to this audience.
  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.
Linking screen showing mapping cards on the left and Batch destination cards on the right.
For more on linking audiences in general, see Link an Audience to the Destination.

​
Field Mapping Reference

Zeotap CDP fieldMaps to (Batch)Required / OptionalNotes
Audience Name (set by Zeotap)nameRequiredThe name Batch uses to identify the audience. Letters, numbers, underscores (_), and hyphens (-) only. Maximum 255 characters. Case-sensitive.
Audience Display Namedisplay_nameOptionalHuman-readable description shown in Batch.
Audience TypetypeRequiredMust be one of custom_ids, emails, or install_ids, and must match the identifier you map.
Mapped ID fieldaudience identifierRequiredThe user identifier each record is added under (e.g., email, custom user ID, install ID).
Mapped attribute fieldsuser attributesOptionalUp to 15 attributes per user. Additional attributes beyond 15 are not sent.

​
Activate and Test the Integration

Once the segment is linked and saved, verify the data has reached Batch.
1

Wait for the sync

Zeotap encrypts and sends the audience data to Batch in the background, based on the refresh frequency you chose.
2

Verify in Batch

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.
Batch Audiences list showing a synced audience with Total IDs in this audience around 5K.
A successful integration looks like this: your audience appears in Batch under Data → Audiences with the expected identifier count and the correct audience type, ready to be used for campaign targeting.
Batch processes the 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

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.

​
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.
Last modified on May 5, 2026