Get program by ID

Gets a program by its ID


Use this operation to retrieve a program by its ID.

In the response, there are five possible status types:

  • Draft
    The program is in a draft state and is not active; a previously activated program can return to a draft state if no contacts have ever been enrolled on it
  • Deactivated
    The program has been deactivated after being activated, in which time it had enrolled contacts
  • Active
    The program is active
  • ReadOnly
    The program has been deleted and then recovered but for a certain reason can't return to a draft or deactivated state. For example, this could be because it was once an active program that had enrolled contacts, and referenced contact data fields and/or sent campaigns that have since been deleted.
  • NotAvailableInThisVersion
    This feature is not available in the version of the API you're using

Path Params
int32
required

The numeric identifier of the program you want details for.

Headers
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, or the feature is not active.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json