Skip to Content

Inxmail

Sync recipients to Inxmail Professional for enterprise email marketing campaigns. Zeotap keeps your Inxmail recipient lists in sync with your warehouse data, enabling targeted campaigns with up-to-date customer attributes.

Prerequisites

  • An Inxmail Professional account with REST API access enabled
  • API credentials (API key and API secret) generated from your Inxmail account
  • Your Inxmail space alias (used to construct the API base URL)

Authentication

Inxmail uses HTTP Basic Authentication with API credentials.

  1. Log in to your Inxmail Professional account
  2. Navigate to Administration > API Credentials
  3. Click Create new API credentials
  4. Copy the generated API Key and API Secret
  5. In Zeotap, paste the API Key into the API Key field
  6. Paste the API Secret into the API Secret field

Configuration

FieldTypeRequiredDescription
Space AliasTextYesYour Inxmail space alias, used to construct the API base URL (https://{space_alias}.api.inxmail.com).

To find your space alias, check the URL you use to access the Inxmail API or contact your Inxmail account administrator.

Target Settings

FieldTypeRequiredDescription
Mailing List IDTextNoInxmail mailing list ID to subscribe recipients to. Required for audience syncs.

To find your Mailing List ID, navigate to Lists in Inxmail Professional. The ID is displayed in the list overview or can be retrieved via the GET /lists API endpoint.

Supported Operations

Sync Modes

ModeSupported
UpsertYes
InsertYes
UpdateYes

Audience Sync Modes

ModeSupported
AddYes
RemoveYes
MirrorYes
UpsertYes

Features

  • Field Mapping: Yes
  • Schema Introspection: No

Required Mapping Fields

FieldDescription
emailRecipient email address (primary identifier)

Default Destination Fields

email, firstName, lastName, company, salutation, title, phone, city, country

These fields correspond to common Inxmail recipient attributes. You can map additional custom attributes defined in your Inxmail account.

How It Works

Contact Sync (Upsert Mode)

  1. Zeotap sends each recipient to the Inxmail Recipients endpoint (POST /recipients)
  2. If the recipient already exists (HTTP 409), Zeotap updates the recipient via PATCH /recipients/{email}
  3. If a Mailing List ID is configured, recipients are subscribed to the list via POST /lists/{listId}/subscriptions

Audience Sync (Add/Remove/Mirror)

  • Add: Recipients are created/updated, then subscribed to the mailing list via POST /lists/{listId}/subscriptions
  • Remove: Recipients are unsubscribed from the mailing list via POST /lists/{listId}/unsubscriptions
  • Mirror: Added/changed recipients are upserted and subscribed; removed recipients are unsubscribed from the list

Insert Mode

Recipients are created individually via POST /recipients. If a recipient already exists, the sync reports an error for that row (use upsert if you want to update existing recipients).

Update Mode

Existing recipients are updated individually via PATCH /recipients/{email} using the merge-patch format. Recipients that do not exist in Inxmail will return an error.

Rate Limits

LimitValue
Standard rate limit600 requests per minute
Higher limitsAvailable by contacting Inxmail

Zeotap automatically retries on 429 Too Many Requests responses with exponential backoff and respects Retry-After headers.

Best Practices

  • Use upsert mode for most recipient syncs to avoid errors when recipients already exist
  • Configure a Mailing List ID for audience syncs to manage list subscriptions automatically
  • Map standard attributes like firstName, lastName, and company to ensure consistent data in Inxmail
  • Verify your space alias before configuring the destination to ensure the correct API endpoint is used
  • Keep sync schedules reasonable to stay within the 600 RPM rate limit

Troubleshooting

Authentication failed: invalid API credentials

Verify that both the API Key and API Secret are correct. Generate new credentials from Administration > API Credentials in Inxmail Professional if needed.

Space alias not found (connection error)

Ensure the space alias is correct. The alias is the subdomain portion of your Inxmail API URL (e.g., my-company for https://my-company.api.inxmail.com).

Recipient already exists (insert mode)

The insert sync mode only creates new recipients. If a recipient with the same email already exists, the sync reports an error. Use upsert mode to create or update recipients.

Recipient not found (update mode)

The update sync mode only updates existing recipients. If the recipient does not exist in Inxmail, the sync reports an error. Use upsert mode to handle both new and existing recipients.

Mailing List ID not found

Verify that the Mailing List ID exists by checking the list overview in Inxmail Professional or by calling GET /lists via the API.

Rate limit exceeded (429 errors)

Zeotap retries automatically with exponential backoff. If errors persist, consider spacing out your sync schedule or contacting Inxmail to request a higher rate limit.

Subscription event failed

Ensure the recipient exists in Inxmail before attempting to subscribe them to a list. In upsert and add modes, Zeotap creates the recipient before subscribing. If using a custom integration, verify that the recipient was created successfully first.

Custom attributes not syncing

Ensure that the attribute names you are mapping match the attribute keys defined in your Inxmail account. Inxmail attributes are case-sensitive. Check your attribute configuration under Administration > Attributes in Inxmail Professional.

Last updated on