Skip to Content

Ongage

Sync contacts to Ongage for multi-ESP email marketing management. Zeotap keeps your Ongage contact lists in sync with your warehouse data, enabling targeted campaigns across multiple Email Service Providers from a single dashboard.

Prerequisites

  • An Ongage account with API access enabled
  • Ongage user credentials (username and password) with API permissions
  • Your Ongage account code (found under Settings > Profile > Company & Contact Information)
  • The List ID of the target contact list in Ongage

Authentication

Ongage uses credential-based authentication with three required values passed as HTTP headers.

  1. Log in to your Ongage account
  2. Navigate to Settings > Profile > Company & Contact Information
  3. Copy your Account Code
  4. In Zeotap, enter your Ongage Username, Password, and Account Code

Your API call limits are visible on the Account Profile page under the Usage section. Contact Ongage support if you need higher limits.

Configuration

No additional configuration fields are required beyond authentication. All settings are handled via target settings and authentication credentials.

Target Settings

FieldTypeRequiredDescription
List IDTextYesOngage list (database) ID to sync contacts to. Found under Lists in your Ongage dashboard.

To find your List ID, navigate to Lists in Ongage. The numeric ID is displayed next to each list name.

Supported Operations

Sync Modes

ModeSupported
UpsertYes
InsertYes

Audience Sync Modes

ModeSupported
AddYes
RemoveYes
UpsertYes
Mirror

Features

  • Field Mapping: Yes
  • Schema Introspection: No

Required Mapping Fields

FieldDescription
emailContact email address (primary identifier)

Default Destination Fields

email, first_name, last_name, country, city, phone, gender, address, ip

You can sync any custom list field that has been created in your Ongage account. Custom fields are passed directly using the field name as defined in Ongage.

How It Works

Contact Sync (Upsert Mode)

  1. Zeotap sends each contact individually to the Ongage Contacts API (POST /<list_id>/api/v2/contacts)
  2. The overwrite flag is set to true, so existing contacts are updated and new contacts are created
  3. Contact attributes are passed in the fields object alongside the email address

Insert Mode

Contacts are created via POST /<list_id>/api/v2/contacts with overwrite set to false. If a contact with the same email already exists, the API returns an error for that row.

Audience Sync (Add/Remove)

  • Add: Contacts are created or updated in the specified list using the upsert flow
  • Remove: Contacts are unsubscribed from the list via POST /<list_id>/api/v2/contacts/change_status with change_to set to unsubscribe. Contacts are batched in groups of up to 100 emails per request.

Bulk Operations

For high-volume syncs, Ongage also supports a CSV-based import endpoint (POST /api/import). Zeotap uses the v2 contacts API for individual precision and per-contact error reporting.

Rate Limits

DetailValue
Rate limit modelPer-minute (account-specific)
Default limitVisible on your Ongage Account Profile > Usage page
Limit scopePer API user account

Zeotap automatically retries on 429 Too Many Requests and 5xx server error responses with exponential backoff.

Best Practices

  • Use upsert mode for most contact syncs to avoid errors when contacts already exist
  • Verify your API call limits on the Ongage Account Profile page before scheduling high-frequency syncs
  • Map custom fields using the exact field names as defined in your Ongage list settings
  • Use the remove audience mode to unsubscribe contacts rather than deleting them, preserving analytics history
  • Check List ID accuracy — an incorrect List ID will cause all contacts in the batch to fail

Troubleshooting

Authentication failed: check username, password, and account code

Verify all three credentials are correct. The account code is found under Settings > Profile > Company & Contact Information in Ongage. Ensure the API user has sufficient permissions.

Contact not created (insert mode)

The insert sync mode fails for contacts that already exist in Ongage. Switch to upsert mode if you want to update existing contacts automatically.

API rate limit exceeded

Your Ongage account has a maximum number of API calls per minute. Check your limit under Account Profile > Usage. Consider reducing sync frequency or contact Ongage support to increase your limit.

Custom field not recognized

Ensure the field name in your mapping exactly matches the field name in your Ongage list. Navigate to Lists > List Fields in Ongage to verify the field exists and check its name.

List ID not found

Verify the List ID exists by navigating to Lists in your Ongage account. The ID is a numeric value displayed next to each list name. If using a non-default list, confirm the API user has access to it.

Contacts not appearing in list

If contacts are synced but not visible in your Ongage list, check that you are using the correct List ID and that the contacts have valid email addresses. Also verify that contacts are not being filtered by an active segment.

Last updated on