Dotdigital

Manage contacts, address books, email campaigns, automation programs, and send transactional emails with the Dotdigital marketing platform.

Detail	Value
Category	Marketing
Base URL	https://r1-api.dotdigital.com/v2
Authentication	API Key
Endpoints	21
Connector key	dotdigital

Using Dotdigital in a workflow

1. Go to Connections and click New Connection.
2. Pick Dotdigital from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

Endpoint	Summary
GET /contacts/{email}	Get contact by email
POST /contacts	Create or update a contact
DELETE /contacts/{email}	Delete contact by email
GET /contacts/unsubscribed-since/{date}	Get contacts unsubscribed since date
GET /contacts/suppressed-since/{date}	Get suppressed contacts since date
GET /address-books	List all address books
POST /address-books	Create an address book
GET /address-books/{id}/contacts	List contacts in address book
POST /address-books/{id}/contacts	Add contact to address book
DELETE /address-books/{id}/contacts/{email}	Remove contact from address book
GET /campaigns/with-activity-since/{dateTime}	List campaigns with activity since date
GET /campaigns/{id}	Get campaign by ID
GET /campaigns/{id}/summary	Get campaign summary statistics
GET /campaigns/{id}/activity-since/{dateTime}	Get campaign contact activity since date
GET /data-fields	List all data fields
POST /data-fields	Create a data field
DELETE /data-fields/{name}	Delete a data field
GET /programs	List all automation programs
POST /programs/enrolments	Enrol contacts in a program
POST /email/send	Send a transactional email
GET /account-info	Get account information

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /contacts/{email}

Get contact by email

Detail	Value
Operation ID	contacts.getByEmail
Method	GET
Path	/contacts/{email}

Parameters

Name	Location	Type	Required
email	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select contacts.getByEmail.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /contacts

Create or update a contact

Detail	Value
Operation ID	contacts.createOrUpdate
Method	POST
Path	/contacts

Parameters

No parameters.

Request Body

Field	Type
email	string
optInType	string
dataFields	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select contacts.createOrUpdate.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

DELETE /contacts/{email}

Delete contact by email

Detail	Value
Operation ID	contacts.deleteByEmail
Method	DELETE
Path	/contacts/{email}

Parameters

Name	Location	Type	Required
email	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select contacts.deleteByEmail.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /contacts/unsubscribed-since/{date}

Get contacts unsubscribed since date

Detail	Value
Operation ID	contacts.listUnsubscribed
Method	GET
Path	/contacts/unsubscribed-since/{date}

Parameters

Name	Location	Type	Required
date	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select contacts.listUnsubscribed.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /contacts/suppressed-since/{date}

Get suppressed contacts since date

Detail	Value
Operation ID	contacts.listSuppressed
Method	GET
Path	/contacts/suppressed-since/{date}

Parameters

Name	Location	Type	Required
date	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select contacts.listSuppressed.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /address-books

List all address books

Detail	Value
Operation ID	addressBooks.list
Method	GET
Path	/address-books

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select addressBooks.list.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /address-books

Create an address book

Detail	Value
Operation ID	addressBooks.create
Method	POST
Path	/address-books

Parameters

No parameters.

Request Body

Field	Type
name	string
visibility	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select addressBooks.create.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /address-books/{id}/contacts

List contacts in address book

Detail	Value
Operation ID	addressBooks.listContacts
Method	GET
Path	/address-books/{id}/contacts

Parameters

Name	Location	Type	Required
id	path	integer	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select addressBooks.listContacts.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /address-books/{id}/contacts

Add contact to address book

Detail	Value
Operation ID	addressBooks.addContact
Method	POST
Path	/address-books/{id}/contacts

Parameters

Name	Location	Type	Required
id	path	integer	Yes

Request Body

Field	Type
email	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select addressBooks.addContact.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

DELETE /address-books/{id}/contacts/{email}

Remove contact from address book

Detail	Value
Operation ID	addressBooks.removeContact
Method	DELETE
Path	/address-books/{id}/contacts/{email}

Parameters

Name	Location	Type	Required
id	path	integer	Yes
email	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select addressBooks.removeContact.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /campaigns/with-activity-since/{dateTime}

List campaigns with activity since date

Detail	Value
Operation ID	campaigns.listWithActivitySince
Method	GET
Path	/campaigns/with-activity-since/{dateTime}

Parameters

Name	Location	Type	Required
dateTime	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select campaigns.listWithActivitySince.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /campaigns/{id}

Get campaign by ID

Detail	Value
Operation ID	campaigns.getById
Method	GET
Path	/campaigns/{id}

Parameters

Name	Location	Type	Required
id	path	integer	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select campaigns.getById.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /campaigns/{id}/summary

Get campaign summary statistics

Detail	Value
Operation ID	campaigns.getSummary
Method	GET
Path	/campaigns/{id}/summary

Parameters

Name	Location	Type	Required
id	path	integer	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select campaigns.getSummary.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /campaigns/{id}/activity-since/{dateTime}

Get campaign contact activity since date

Detail	Value
Operation ID	campaigns.getActivitySince
Method	GET
Path	/campaigns/{id}/activity-since/{dateTime}

Parameters

Name	Location	Type	Required
id	path	integer	Yes
dateTime	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select campaigns.getActivitySince.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /data-fields

List all data fields

Detail	Value
Operation ID	dataFields.list
Method	GET
Path	/data-fields

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select dataFields.list.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /data-fields

Create a data field

Detail	Value
Operation ID	dataFields.create
Method	POST
Path	/data-fields

Parameters

No parameters.

Request Body

Field	Type
name	string
type	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select dataFields.create.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

DELETE /data-fields/{name}

Delete a data field

Detail	Value
Operation ID	dataFields.delete
Method	DELETE
Path	/data-fields/{name}

Parameters

Name	Location	Type	Required
name	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select dataFields.delete.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /programs

List all automation programs

Detail	Value
Operation ID	programs.list
Method	GET
Path	/programs

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select programs.list.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /programs/enrolments

Enrol contacts in a program

Detail	Value
Operation ID	programs.enrolContacts
Method	POST
Path	/programs/enrolments

Parameters

No parameters.

Request Body

Field	Type
programId	integer
contacts	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select programs.enrolContacts.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

POST /email/send

Send a transactional email

Detail	Value
Operation ID	email.sendTransactional
Method	POST
Path	/email/send

Parameters

No parameters.

Request Body

Field	Type
campaignId	integer
toAddresses	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select email.sendTransactional.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.

GET /account-info

Get account information

Detail	Value
Operation ID	account.getInfo
Method	GET
Path	/account-info

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Dotdigital connection from the Connection dropdown.
3. In the Operation dropdown, select account.getInfo.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Dotdigital API reference.