Skip to main content

Dotdigital API Endpoints

The Dotdigital API endpoints the iPaaS.com integration uses for contacts, transactions (insight data), and loyalty certificates, plus authentication and rate limits.

This article lists the Dotdigital API endpoints the iPaaS.com integration uses, grouped by area.

Base URL

The integration calls the Dotdigital API at the regional host shown on your Dotdigital account's API users page (Settings → Access → API users). The host is region-specific — for example https://r2-api.dotmailer.com. Replace {Base URL} in the paths below with your account's host.

Authentication

Dotdigital uses HTTP Basic authentication. The integration sends the API User and API Password configured in the subscription settings with each request. See the Dotdigital Connections and Settings article for how to create and enter these credentials.

Table of Contents

  • Contact Endpoints

  • Transaction Endpoints

  • Gift Card Endpoints

  • Utility Endpoints

Contact Endpoints

Get a Contact (GET)

{Base URL}/contacts/v3/contact-id/{ContactId}

Create a Contact (POST)

{Base URL}/contacts/v3

Update a Contact (PATCH)

{Base URL}/contacts/v3/contact-id/{ContactId}

Delete a Contact (DELETE)

{Base URL}/contacts/v3/contact-id/{ContactId}

Transaction Endpoints

Transactions are written as Dotdigital insight data, stored against a contact in a named collection.

Create a Collection (POST)

{Base URL}/insight-data/v3/collections/{CollectionName}?collectionScope={CollectionScope}&collectionType={CollectionType}

Create or Update a Transaction (PATCH)

{Base URL}/insight-data/v3/contacts/{IdentifierType}/{IdentifierValue}/{CollectionName}/{TransactionKey}

Get a Transaction (GET)

{Base URL}/insight-data/v3/contacts/{IdentifierType}/{IdentifierValue}/{CollectionName}/{TransactionKey}

Delete a Transaction (DELETE)

{Base URL}/insight-data/v3/contacts/{IdentifierType}/{IdentifierValue}/{CollectionName}/{TransactionKey}

Gift Card Endpoints

Loyalty certificates are delivered by triggering a Dotdigital campaign.

Send a Loyalty Certificate (POST)

{Base URL}/v2/email/triggered-campaign

Utility Endpoints

Get all Campaigns (GET)

{Base URL}/v2/campaigns

Pagination

Dotdigital list endpoints that return multiple records use select (page size) and skip (offset) query parameters to page through results. Confirm the exact behavior and limits against the Dotdigital developer documentation.

Rate Limits and Concurrency

Dotdigital enforces API rate limits per account. The integration's throttle and concurrency values are configured in the subscription settings (see the Dotdigital Connections and Settings article). When a rate limit is reached, the transfer is automatically rescheduled to resume after the limit window resets. For the current published limits, see the Dotdigital developer documentation at https://developer.dotdigital.com.

Related Documents

Related Articles
Did this answer your question?