Create program enrolment

post

https://{region}-api.dotdigital.com/v2/programs/enrolments

Creates a program enrolments for passed contacts and/or lists/address books.

Note: This happens asynchronously, use the id to track progress.

This operation enrolls either a collection of contacts or all contacts within specified address books (lists) onto a automation program.

📘
Contacts or address books (lists)
You can either pass an array of contact IDs or address book IDs, but not both.

An enrolment ID (GUID) is returned for the enrolment, and this can be used to retrieve details of the enrolment in other operations.

The possible status types are:

'Processing' - The enrolment is currently processing and has yet to finish
'Finished' - The enrolment has finished processing
'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using

🚧
API Limits
Limits:

Maximum 1000 contactIds per request.

Maximum 10 listIds/addressBookIds per request.

This call does not count towards API call limits.
To ensure enrolment efficiency, we recommend:

Batching multiple enrolments into a single call.

Avoiding high-frequency, single-contact enrolments.

Headers

x-ddg-integration-token

string

/^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses

401

Invalid or missing credentials.

403

The account does not have the Programs permission.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Contacts or address books (lists)

API Limits

201Enrolments accepted

404The specified program was not found (ERROR_PROGRAM_NOT_FOUND).

422The program exists but is not active (ERROR_PROGRAM_NOT_ACTIVE).