{"_id":"5c9c9eaf69d53801292d3b07","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"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","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"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":6,"slug":"campaigns","title":"Campaigns"},"user":"5c3740967267aa42020e5cce","__v":7,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-03-28T10:15:11.349Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"New product promotion 2\",\n  \"subject\": \"New product!\",\n  \"fromName\": \"Company name\",\n  \"fromAddress\": {\n    \"id\": 133618,\n    \"email\": \"products:::at:::mycompany.com\"\n  },\n  \"htmlContent\": \"\\r\\n<!-- Easy Editor -->\\r\\n<table width=\\\"100%\\\" border=\\\"0\\\" cellspacing=\\\"0\\\" cellpadding=\\\"0\\\" style=\\\"table-layout: auto;\\\" class=\\\"ee_resizable ee_mobiletemplate\\\" data-dmtmp=\\\"true\\\">\\r\\n  <tbody>\\r\\n    <tr>\\r\\n      <td align=\\\"center\\\" bgcolor=\\\"#ffffff\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\">\\r\\n        <table width=\\\"600\\\" border=\\\"0\\\" cellspacing=\\\"0\\\" cellpadding=\\\"0\\\" style=\\\"table-layout: auto;\\\" class=\\\"eem_mainouterzone\\\">\\r\\n          <tbody>\\r\\n            <tr>\\r\\n              <td bgcolor=\\\"#ffffff\\\" class=\\\"ee_dropzone\\\" style=\\\"padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px;\\\" align=\\\"left\\\">\\r\\n                <table width=\\\"100%\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"width: 600px; background-color: rgb(255, 255, 255); table-layout: auto;\\\" class=\\\"ee_element\\\" bgcolor=\\\"#ffffff\\\">\\r\\n                  <tbody>\\r\\n                    <tr>\\r\\n                      <td align=\\\"left\\\" style=\\\"padding: 0px; width: 600px;\\\" class=\\\"\\\"><div class=\\\"ee_editable\\\"><font style=\\\"font-family: 'trebuchet ms', verdana, arial, sans-serif; font-size: 13px;\\\"><a href=\\\"http://$UNSUB$\\\" style=\\\"color: black;\\\"> Unsubscribe from this newsletter</a></font> </div></td>\\r\\n                    </tr>\\r\\n                  </tbody>\\r\\n                </table>\\r\\n              </td>\\r\\n            </tr>\\r\\n          </tbody>\\r\\n        </table>\\r\\n      </td>\\r\\n    </tr>\\r\\n  </tbody>\\r\\n</table>\",\n  \"plainTextContent\": \"\\r\\n\\r\\n---\\r\\nWant to unsubscribe? $UNSUB$\",\n  \"replyAction\": \"Unset\",\n  \"replyToAddress\": \"\",\n  \"isSplitTest\": true,\n  \"status\": \"Unsent\",\n  \"type\": \"Standard\",\n  \"tags\": [\n    {\n      \"name\": \"Product\"\n    },\n    {\n      \"name\": \"Promotion\"\n    }\n  ],\n  \"splitTestOptions\": [\n    \"Subject\",\n    \"FromAddress\",\n    \"FromName\",\n    \"Html\",\n    \"PlainText\"\n  ],\n  \"sentDate\": \"2019-03-01T16:09:48.07\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/campaigns/1/with-details\";\n\nusing (var httpClient = new HttpClient())\n{\n  httpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n  var credentials = Encoding.ASCII.GetBytes(\"username:password\");\n  httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n  var result = httpClient.GetAsync(url).Result;\n}","language":"csharp"}]},"method":"get","auth":"required","params":[{"_id":"5ca61bfcb56a66005cd3a77a","ref":"","in":"path","required":true,"desc":"The ID of the campaign, which needs to be included within the URL","default":"","type":"int","name":"ID"}],"url":"/v:version/campaigns/[ID]/with-details"},"isReference":false,"order":14,"body":"This operation retrieves an existing campaign within your account by its ID, including all of the campaign's details. \n\nThese details are an extension to Get campaign, and comprise of the following final four properties to be returned:\n\n  * Type: This can be 'Standard', 'Triggered', or 'NotAvailableInThisVersion'\n  * Tags: This is an array of the campaign tags assigned to the campaign. The array will be empty if no campaign tags are assigned.\n  * Split test options: This is an array of the the campaign split test options that have been made use of - 'Subject', 'FromAddress', 'FromName', 'Html', and 'PlainText' \n  * Sent date: This is the most recent date and time that the campaign was sent. If the campaign hasn't been sent before, then '1970-01-01T00:00:00' will be returned.","excerpt":"Gets a campaign by ID, along with all its details","slug":"get-campaign-with-details","type":"endpoint","title":"Get campaign with details"}

getGet campaign with details

Gets a campaign by ID, along with all its details

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the campaign, which needs to be included within the URL

Examples


Result Format


Documentation

This operation retrieves an existing campaign within your account by its ID, including all of the campaign's details. These details are an extension to Get campaign, and comprise of the following final four properties to be returned: * Type: This can be 'Standard', 'Triggered', or 'NotAvailableInThisVersion' * Tags: This is an array of the campaign tags assigned to the campaign. The array will be empty if no campaign tags are assigned. * Split test options: This is an array of the the campaign split test options that have been made use of - 'Subject', 'FromAddress', 'FromName', 'Html', and 'PlainText' * Sent date: This is the most recent date and time that the campaign was sent. If the campaign hasn't been sent before, then '1970-01-01T00:00:00' will be returned.