{"_id":"55f2a7e4d1c4c7170033df23","editedParams2":true,"parentDoc":null,"project":"55dd9f2e0efd5821000d54d9","editedParams":true,"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":2,"category":{"_id":"55e047a9a44fae0d00214672","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":22,"pages":["55eda104a872a80d00acffa7","55eda7d9df21af2b009e21ec","55eda8e1ec4c3e3900b75676","55edad128dcb210d00568ff0","55edae26df21af2b009e21f9","55edb180a872a80d00acffcd","55edb8778dcb210d00569009","55ef0935e7f5490d000c0e1e","55ef0e40bfb7ae0d0013ad92","55ef121cb97ce63700d0599b","55ef18198eb7ae0d00feeb58","55f0526c8a93b22b0083fed3","55f054af8a93b22b0083fed5","55f0553aa1f8a4230086c79d","55f297f91741861700249dc4","55f2a7e4d1c4c7170033df23","55f2a8c4fb7aad2300bf17c2","55f2aabed1c4c7170033df27","55f2acbe525cb12300c6c4e2","560158002499c119000fae2c","560163939137690d00335741","56016d072499c119000fae94"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:36:09.580Z","from_sync":false,"order":4,"slug":"campaigns","title":"Campaigns"},"user":"55dd9841cafe7221002a4c62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-11T10:07:32.690Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n  \"id\": \"842d81e8-c619-457f-bb77-ab6c4a17da39\",\n  \"campaignId\": 1,\n  \"addressBookIds\": null,\n  \"contactIds\": null,\n  \"sendDate\": \"2015-09-11T11:06:47.7644899+01:00\",\n  \"splitTestOptions\": null,\n  \"status\": \"Sent\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"name":"","code":"var url = \"/v2/campaigns/send/842d81e8-c619-457f-bb77-ab6c4a17da39\";\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/campaigns/send/842d81e8-c619-457f-bb77-ab6c4a17da39\";\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","auth":"required","params":[{"_id":"57f62ce42da80e2000790804","ref":"","in":"path","required":true,"desc":"The send ID of the campaign, which needs to be included within the URL. The send ID is a GUID, looking something like 842d81e8-c619-457f-bb77-ab6c4a17da39.","default":"","type":"int","name":"ID"}],"url":"/v:version/campaigns/send/[ID]"},"isReference":false,"order":6,"body":"This operation gets the progress of a sent campaign by the campaign's send ID. It will return a status indicating where the campaign is in the sending process.\n\nThe possible status types are:\n\n  * 'NotSent' - The campaign has not started sending yet\n  * 'Scheduled' - The campaign is scheduled for sending\n  * 'Sending' - The campaign has begun sending and has not yet finished sending\n  * 'Sent' - The campaign has completed sending\n  * 'Cancelled' - The campaign send was cancelled\n  * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Gets a campaign send status using send ID","slug":"get-campaign-send-status","type":"endpoint","title":"Get campaign send status"}

getGet campaign send status

Gets a campaign send status using send ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The send ID of the campaign, which needs to be included within the URL. The send ID is a GUID, looking something like 842d81e8-c619-457f-bb77-ab6c4a17da39.

Examples


Result Format


Documentation

This operation gets the progress of a sent campaign by the campaign's send ID. It will return a status indicating where the campaign is in the sending process. The possible status types are: * 'NotSent' - The campaign has not started sending yet * 'Scheduled' - The campaign is scheduled for sending * 'Sending' - The campaign has begun sending and has not yet finished sending * 'Sent' - The campaign has completed sending * 'Cancelled' - The campaign send was cancelled * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using