{"_id":"560017ac1503430d007cc749","user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":44,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams2":true,"project":"55dd9f2e0efd5821000d54d9","__v":1,"category":{"_id":"55f036e92911b72100482cd9","version":"55dd9f4dab0e4d210045aae9","project":"55dd9f2e0efd5821000d54d9","__v":6,"pages":["56001a080c703d1900953023","56001b8bfeaf310d007dd748","56001d260c703d1900953024","560023591503430d007cc75a","560025601503430d007cc75c","56002f480c703d1900953033"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:40:57.710Z","from_sync":false,"order":13,"slug":"programs","title":"Programs"},"githubsync":"","parentDoc":null,"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T14:43:56.414Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"var url = \"/v2/programs/1\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.GetAsync(url).Result;\n}","language":"csharp"},{"code":"","language":"json"},{"code":"$url = $baseUrl . \"/v2/programs/1“;\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n\t$ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n \t'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n\t$ch, CURLOPT_USERPWD,\n $apiUsername . ':' . $apiPassword\n);\n\t\t\t\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n \"id\": 1,\n \"name\": \"Birthday program\",\n \"status\": \"Active\",\n \"dateCreated\": \"2013-01-08T14:56:53\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56000f150c703d190095300a","ref":"","in":"path","required":true,"desc":"The ID of the program, which needs to be included within the URL","default":"","type":"int","name":"ID"}],"url":"/v:version/programs/[ID]"},"isReference":false,"order":2,"body":"This operation retrieves a program by its ID.\n\nThe possible status types are:\n\n * '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 into it\n * 'Deactivated' - The program has been deactivated after being activated, in which time it had enrolled contacts\n * 'Active' - The program is active\n * '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. \n * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Gets a program by ID","slug":"get-program-by-id","type":"endpoint","title":"Get program by ID"}

Transactional email

More help

getGet program by ID

Gets a program by ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:

required

integer

The ID of the program, which needs to be included within the URL

Examples

Result Format

Documentation

This operation retrieves a program by its ID.
The possible status types are:
* '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 into 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