{"_id":"56001a080c703d1900953023","user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":3,"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":10,"slug":"programs","title":"Programs"},"parentDoc":null,"project":"55dd9f2e0efd5821000d54d9","editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T14:54:00.306Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"var url = \"/v2/programs/enrolments\";\nvar content = :::at:::\"{ \"\"programId\"\": 1, \"\"contacts\"\": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], \"\"addressBooks\"\": [ 3, 4 ] }\";\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.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}\n","language":"csharp"},{"code":"{\n  \"programId\": 1,\n  \"contacts\": [\n    3,\n    4,\n    5,\n    6,\n    7,\n    8,\n    9,\n    10,\n    11,\n    12,\n    13,\n    14,\n    15,\n    16,\n    17,\n    18,\n    19,\n    20,\n    21,\n    22,\n    23\n  ],\n  \"addressBooks\": [\n    3,\n    4\n  ]\n}","language":"json"},{"code":"$content = [];\n$content['ProgramId'] = '1';\n$content['Status'] = '';\n$content['DateCreated'] = '';\n$content['Contacts'] = ['3','4','5','6','7','8','9','10','11','12','13','14','15','16','17','18','19','20','21','22','23'];\n$content['AddressBooks'] = ['3','4'];\n$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/programs/enrolments\";\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\t\t);\n\t\tcurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\n        curl_setopt(\n            $ch, CURLOPT_USERPWD,\n            $apiUsername . ':' . $apiPassword\n        );\n        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\n        curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"post","results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\": \"b0ff06d6-af04-4af8-a299-51bcbad94c1c\",\n  \"programId\": 1,\n  \"status\": \"Processing\",\n  \"dateCreated\": \"2015-01-01T00:00:00\",\n  \"contacts\": null,\n  \"addressBooks\": null\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56001b249e7ccf0d000a1eb0","ref":"","in":"body","required":true,"desc":"The ID of the program, which needs to be included within the request body","default":"","type":"int","name":"ProgramID"},{"_id":"56001b249e7ccf0d000a1ead","ref":"","in":"body","required":false,"desc":"The IDs of the contacts to be enrolled into the program, which needs to be included within the request body (up to 1000 contact IDs per request)","default":"","type":"array_int","name":"Contacts"},{"_id":"56001b249e7ccf0d000a1eac","ref":"","in":"body","required":false,"desc":"The IDs of the address books to be enrolled into the program, which which needs to be included within the request body","default":"","type":"array_int","name":"AddressBooks"}],"url":"/v:version/programs/enrolments"},"isReference":false,"order":2,"body":"This operation creates a program enrolment.\n\nAn enrolment ID (GUID) is returned for the enrolment, and this can be used to retrieve details of the enrolment in other operations.  \n\nThe possible status types are:\n\n  * 'Processing' - The enrolment is currently processing and has yet to finish\n  * 'Finished' - The enrolment has finished processing\n  * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using\n\nPlease note that your account can only call this a maximum of 20 times per hour, across all programs.","excerpt":"Creates a program enrolment","slug":"create-program-enrolment","type":"endpoint","title":"Create program enrolment"}

postCreate program enrolment

Creates a program enrolment

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ProgramID:
required
integer
The ID of the program, which needs to be included within the request body
Contacts:
array of integers
The IDs of the contacts to be enrolled into the program, which needs to be included within the request body (up to 1000 contact IDs per request)
AddressBooks:
array of integers
The IDs of the address books to be enrolled into the program, which which needs to be included within the request body

Examples


Result Format


Documentation

This operation creates a program enrolment. 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 Please note that your account can only call this a maximum of 20 times per hour, across all programs.