Skip to Content
DestinationsMarketingOptimizely Campaign

Optimizely Campaign

Sync recipients and audiences into an Optimizely Campaign (formerly Episerver Campaign) recipient list. Zeotap adds new recipients to the list, keeps their attributes up to date from your warehouse, and removes them when they leave an audience, so your email campaigns always target the right people with current data.

This destination is for Optimizely Campaign, Optimizely’s email and marketing-automation product. To send audiences to Optimizely’s web experimentation product, use the Optimizely destination instead.

Prerequisites

  • An Optimizely Campaign client with the REST API enabled. Optimizely customer support sets this up on request.
  • A REST API user for that client. Customer support creates it for an email address on your login domain that you do not use for anything else, and sends an activation mail to that address.
  • Your client ID and the ID of the recipient list you want to sync into.
  • Recipient list fields for every attribute you want to sync. Zeotap writes to existing fields; it does not create new ones.

Authentication

Optimizely Campaign uses HTTP Basic Authentication with the REST API user.

  1. Ask Optimizely customer support to set up the REST API and an API user for your client, if you have not already.
  2. Activate the API user from the activation mail and set its password.
  3. In Zeotap, enter the API user’s login (its email address) in API User.
  4. Enter its password in API Password. The password is stored encrypted and never shown again.

Configuration

FieldTypeRequiredDescription
Client IDTextYesYour Optimizely Campaign client ID.
Recipient ListSelectYesThe recipient list Zeotap adds recipients to, updates and removes them from. Pick a list from the dropdown or type its numeric ID.
Opt-in Process IDTextNoThe opt-in process new recipients are added under. Leave blank to add recipients without one.

To find your client ID, open Optimizely Campaign and go to Administration > API Overview > REST API. Recipient list IDs are shown in the recipient list overview, and the dropdown lists every list the API user can see.

Each destination writes to one recipient list. To sync into several lists, create one destination per list.

Opt-in processes

If you set an opt-in process, new recipients are added under it. With a double opt-in process, Optimizely sends each new recipient a confirmation email and they only join the list once they confirm, so they will not appear in the list straight away. A double opt-in is never overwritten by another opt-in process.

Supported Operations

Sync Modes

ModeSupportedWhat it does
UpsertYesAdds new recipients and updates the attributes of recipients already in the list
InsertYesAdds new recipients only; recipients already in the list are reported as errors
UpdateYesUpdates recipients already in the list only; recipients not in the list are reported as errors

Audience Sync Modes

ModeSupportedWhat it does
AddYesAdds audience members to the recipient list
RemoveYesDeletes members who left the audience from the recipient list
MirrorYesAdds and updates current members, and deletes members who left
UpsertYesAdds new members and updates existing ones

Features

  • Field Mapping: Yes
  • Schema Introspection: Yes. The mapping screen lists the recipient list’s own fields.

Required Mapping Fields

FieldDescription
emailRecipient email address. Used as the recipient ID unless recipient_id is also mapped.

Map recipient_id instead of, or as well as, email when your recipient list identifies recipients by something other than the email address, such as a customer number. When both are mapped, recipient_id is the recipient ID and email is sent as the recipient’s address.

Default Destination Fields

email, recipient_id

Every other mapped field is written to the recipient list field of the same name. Use the list’s internal field names (for example firstname), which the mapping screen offers once the destination is connected.

How It Works

Adding and updating recipients

  1. Zeotap sends recipients to the recipient list in batches of up to 1,000.
  2. Optimizely Campaign returns the recipients it could not add, for example because they are already in the list.
  3. In upsert, add and mirror modes, Zeotap then updates the attributes of those recipients instead. A recipient with no attributes mapped is checked instead, and counts as synced if it is already in the list.
  4. A recipient that can be neither added nor updated, for example because it is blocklisted, has unsubscribed or has exceeded the bounce limit, is reported as a failed row with the reason.

Removing recipients

When a member leaves an audience in remove or mirror mode, Zeotap deletes them from the recipient list, in batches of up to 100. Deleting a recipient removes them and their attributes from that list only; it does not add them to your unsubscribe list or blocklist, so they can be added again if they rejoin the audience.

Errors and retries

Requests that fail with a rate limit or a temporary server error are retried automatically with backoff. Other failures are reported per row, so one bad batch does not stop the sync.

Rate Limits

LimitValue
Parallel REST API connections per client40 by default; customer support can raise it

Zeotap sends recipient writes one request at a time per sync. When it checks whether already-present recipients are in the list (the upsert and add paths for rows that carry only an identifier), it runs up to eight of those lookups in parallel, still well under the 40-connection allowance and leaving room for your other integrations on the same client.

Limitations

  • Changing an existing recipient’s email address. On a list keyed by a recipient ID other than the email, a routine sync updates mapped data fields and adds new recipients, but it does not change the email address of a recipient already in the list — in Optimizely Campaign the address is the recipient’s identifier rather than a data field, and changing it uses Campaign’s own identifier-change flow. New recipients are added with their address as normal.

Best Practices

  • Use upsert for most recipient syncs, so new and existing recipients are both handled.
  • Use mirror for audience syncs that should keep a list exactly in step with an audience.
  • Use a dedicated recipient list for each audience you mirror, since mirror deletes recipients who leave the audience.
  • Create list fields first. Add a field to the recipient list in Optimizely Campaign before mapping an attribute to it.
  • Check your opt-in process. A double opt-in delays when new recipients appear in the list; leave the field blank if your recipients have already consented.

Troubleshooting

Authentication failed (HTTP 401 or 403)

Check the API user and password, and that the client ID belongs to this API user. API users are created per client by Optimizely customer support. If the user has not been activated from its activation mail yet, it cannot sign in.

Recipient list not found

The Check the recipient list step fails when the list does not exist or belongs to a different client. Pick the list from the dropdown, or check its ID in the recipient list overview.

Recipients refused when adding

Optimizely Campaign refuses recipients that are blocklisted, have unsubscribed, have exceeded the bounce limit or are not valid addresses. These rows are reported as failed with that reason. In insert mode, recipients already in the list are refused too; use upsert to update them instead.

Recipient not in the list (update mode)

Update mode only changes recipients already in the recipient list. Use upsert to add missing recipients as well.

New recipients do not appear in the list

If you configured a double opt-in process, recipients join the list only after they confirm the opt-in email. Check the opt-in process, or leave the field blank.

Attribute values are not updated

Make sure each mapped destination field matches the internal name of a field in the recipient list. Values for fields the list does not have cannot be stored.

Opt-in process not suitable

If every add fails with an opt-in process error, the configured opt-in process cannot be used for this list. Check the ID under the list’s opt-in settings, or leave the field blank.

Last updated on