Skip to main content

​
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 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 and profile integrations.
This page covers the Batch CEP connector. Confirm with your team which connector to use before starting.

​
Available Actions

Actions are chosen on the Mapping screen under Choose your Action. A destination can hold one mapping per action, so you can set up any combination.
The actions write to different places: Send audiences to Batch writes at the audience level, while Mass Update Profiles and Update Batch profiles write to the profile. Attributes sent with the audience action never land on the profile — see the warning in Action 1.

​
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 and Update Batch 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, Mass Update Profiles, or Update Batch profiles (from Journeys) — 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.
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.

Figure 1 — Opening Account settings from the profile menu in the Batch dashboard.

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 with the values blurred.

Figure 2 — Batch project Settings → General, showing where the Project Key and REST API Key live (values redacted).

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

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.

Figure 3 — The Destinations catalogue with both Batch and Batch CEP cards visible after searching “Batch”.

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 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.
1

Choose the action and map the fields

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).
Zeotap mapping screen showing Last Name, Age (Integer) and Email Raw mapped to last_name, age, and Id.

Figure 4 — Mapping screen with Last Name, Age, and Email Raw mapped to Batch destination fields.

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 instead.
2

Set the Audience Type to match your identifier

Scroll to Additional Settings and pick the Audience Type that matches the identifier you mapped above:
Additional Settings section in Zeotap with the Audience Type dropdown.

Figure 5 — Additional Settings panel with the 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.
3

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.

Figure 6 — Mapping summary showing the chosen action and mapped attributes before saving.

​
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.
Update Batch profiles is the Journeys counterpart of this action. Configure the mapping exactly as described below — the procedure is identical — then use the destination from a journey instead of linking it to a segment.
1

Select the action

On the Mapping screen, under Choose your Action, select Mass Update Profiles.
Zeotap mapping screen named massupdate with the Mass Update Profiles action card selected.

Figure 7 — Choosing the Mass Update Profiles action on the Mapping screen.

2

Map at least one identifier

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.
3

Map the attributes you want to update

Under Attributes, map the profile fields you want to keep in sync. All attributes are optional.
Mass Update Profiles mapping showing the Identifiers section with Custom ID, Installation ID and Device ID, and the Attributes section with Customer Tier, Zeotap Date and Firstname.

Figure 8 — Identifiers and Attributes mapped: Email Raw to Custom ID, Age to Customer Tier, Custom_dateDM to Zeotap Date, and First Name 02 to Firstname.

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.
Attributes list showing Customer Tier, Zeotap Date, Firstname, Lastname, Email Address, Email Marketing and Phone Number.

Figure 9 — The Attributes section of the Mass Update Profiles mapping.

4

Optional: map topic preferences

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.
5

Optional: map events and event attributes

To send events into Batch as well:
  • Under Events, map the event Name.
  • Under Event Attributes, map Label (String) and Tags (List).
Mapping screen showing Topic Preference with an Add field, Events with a Name field, and Event Attributes with Label and Tags fields.

Figure 10 — The Topic Preference, Events and Event Attributes sections at the bottom of the mapping.

6

Save the mapping and link the destination

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 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.
With the destination created, link it to an audience segment so Zeotap starts sending data.
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.

Figure 11 — Linking an audience to a destination from the Audiences list.

2

Select the Batch CEP destination, mapping, and refresh frequency

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.
Linking screen showing mapping cards on the left and Batch destination cards on the right.

Figure 12 — Audience-to-destination linking screen with the mapping and destinations panel.

For more on linking audiences in general, see Link an Audience to the Destination.

​
Field Mapping Reference

​
Send audiences to Batch

​
Mass Update Profiles

This reference also applies to Update Batch profiles, which uses the same mapping. Identifiers — map at least one; you may map several: Attributes — all optional. The following are visible on the mapping screen: 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:

​
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 data to Batch in the background, based on the refresh frequency you chose.
2

Verify Send audiences to 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.

Figure 13 — Batch Data → Audiences with the synced audience and identifier count visible.

3

Verify Mass Update Profiles

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.
Last modified on August 24, 2026