{"_id":"55df16fcddfb40170061cf21","editedParams":true,"__v":5,"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"},"parentDoc":null,"project":"55dd9f2e0efd5821000d54d9","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"},"editedParams2":true,"updates":["5661904836398e0d00f79541","57ed269362436e0e00ea81ad"],"next":{"pages":[],"description":""},"createdAt":"2015-08-27T13:56:12.253Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"id\": 6302600,\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\": false,\n  \"status\": \"Unsent\"\n}","language":"json","status":201}]},"settings":"","examples":{"codes":[{"name":"","code":"var url = \"/v2/campaigns\";\nvar content = @\"{ name: \"\"New product promotion 2\"\", subject: \"\"New product!\"\", fromName: \"\"Company name\"\", htmlContent: \"\"\n<!-- Easy Editor -->\n<table width=\"\"100%\"\" border=\"\"0\"\" cellspacing=\"\"0\"\" cellpadding=\"\"0\"\" style=\"\"table-layout: auto;\"\" class=\"\"ee_resizable ee_mobiletemplate\"\" data-dmtmp=\"\"true\"\">\n  <tbody>\n    <tr>\n      <td align=\"\"center\"\" bgcolor=\"\"#ffffff\"\" cellpadding=\"\"0\"\" cellspacing=\"\"0\"\">\n        <table width=\"\"600\"\" border=\"\"0\"\" cellspacing=\"\"0\"\" cellpadding=\"\"0\"\" style=\"\"table-layout: auto;\"\" class=\"\"eem_mainouterzone\"\">\n          <tbody>\n            <tr>\n              <td bgcolor=\"\"#ffffff\"\" class=\"\"ee_dropzone\"\" style=\"\"padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px;\"\" align=\"\"left\"\">\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\"\">\n                  <tbody>\n                    <tr>\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>\n                    </tr>\n                  </tbody>\n                </table>\n              </td>\n            </tr>\n          </tbody>\n        </table>\n      </td>\n    </tr>\n  </tbody>\n</table>\"\", plainTextContent: \"\"\n\n---\nWant to unsubscribe? $UNSUB$\"\" }\";\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.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}","language":"csharp"},{"code":"{ \n    \"name\": \"New product promotion 2\", \n    \"subject\": \"New product!\", \n    \"fromName\": \"Company name\", \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}","language":"json"},{"code":"$campaign['Name'] = 'New product promotion 2';\n$campaign['Subject'] = 'New product!';\n$campaign['FromName'] = 'Company name';\n$campaign['HtmlContent'] = '<!-- Easy Editor -->\n<table width=\"\"100%\"\" border=\"\"0\"\" cellspacing=\"\"0\"\" cellpadding=\"\"0\"\" style=\"\"table-layout: auto;\"\" class=\"\"ee_resizable ee_mobiletemplate\"\" data-dmtmp=\"\"true\"\">\n  <tbody>\n    <tr>\n      <td align=\"\"center\"\" bgcolor=\"\"#ffffff\"\" cellpadding=\"\"0\"\" cellspacing=\"\"0\"\">\n        <table width=\"\"600\"\" border=\"\"0\"\" cellspacing=\"\"0\"\" cellpadding=\"\"0\"\" style=\"\"table-layout: auto;\"\" class=\"\"eem_mainouterzone\"\">\n          <tbody>\n            <tr>\n              <td bgcolor=\"\"#ffffff\"\" class=\"\"ee_dropzone\"\" style=\"\"padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px;\"\" align=\"\"left\"\">\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\"\">\n                  <tbody>\n                    <tr>\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>\n                    </tr>\n                  </tbody>\n                </table>\n              </td>\n            </tr>\n          </tbody>\n        </table>0\n      </td>\n    </tr>\n  </tbody>\n</table>';\n$campaign['PlainTextContent'] = 'http://$UNSUB$';\n\n$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/campaigns\";\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n    $ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n                                   'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n    $ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($campaign));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"post","auth":"required","params":[{"_id":"55ddc1fdbfd5072d002e7b01","ref":"","in":"body","required":true,"desc":"The name of the campaign being created, which needs to be included within the request body","default":"","type":"string","name":"Name"},{"_id":"55ddc26d0efd5821000d552e","ref":"","in":"body","required":true,"desc":"The email subject line of the campaign, which needs to be included within the request body","default":"","type":"string","name":"Subject"},{"_id":"55ddc26d0efd5821000d552d","ref":"","in":"body","required":true,"desc":"The from name of the campaign, which needs to be included within the request body","default":"","type":"string","name":"FromName"},{"_id":"573a018bdb7d7c3400ecc4e2","ref":"","in":"body","required":false,"desc":"The email of an existing custom from address you wish to use, which needs to be included within the request body","default":"","type":"string","name":"FromAddress.Email"},{"_id":"55df16fcddfb40170061cf23","ref":"","in":"body","required":true,"desc":"The HTML content of the campaign that lies between the opening <body> and the closing </body> only (the <body> tags themselves should not be used). This content needs to be included within the request body.","default":"","type":"string","name":"HtmlContent"},{"_id":"55df16fcddfb40170061cf22","ref":"","in":"body","required":true,"desc":"The plain text content of the campaign, which needs to be included within the request body","default":"","type":"string","name":"PlainTextContent"},{"_id":"573a018bdb7d7c3400ecc4e1","ref":"","in":"body","required":false,"desc":"The required action to be taken when a reply to the campaign is sent by the recipient, which needs to be included within the request body","default":"'Unset', 'WebMailForward', 'Webmail', 'Delete'","type":"string","name":"ReplyAction"},{"_id":"573a018bdb7d7c3400ecc4e0","ref":"","in":"body","required":false,"desc":"The email address that you would like replies to be forwarded to, which needs to be included within the request body","default":"","type":"string","name":"ReplyToAddress"}],"url":"/v:version/campaigns"},"isReference":false,"order":0,"body":"This operation can be used to create a new campaign within your account. You are able to create both HTML and plain text versions of the campaign.\n\nIf you don't specify a reply action, then 'Unset' is the default setting that you'll see in the result. If you're using a 'reply to address', then replies will get stored both in-app and will also go to the 'reply to address' specified. This is also true of the 'WebMailForward' and 'WebMail' settings and thus you will not need to set these.\n\nIf you don't want replies to be stored in-app then set the reply action to 'Delete' (thus they will be deleted). If you're using a 'reply to address' then replies will still go there.","excerpt":"Creates a campaign","slug":"create-campaign","type":"endpoint","title":"Create campaign"}

postCreate campaign

Creates a campaign

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

Name:
required
string
The name of the campaign being created, which needs to be included within the request body
Subject:
required
string
The email subject line of the campaign, which needs to be included within the request body
FromName:
required
string
The from name of the campaign, which needs to be included within the request body
FromAddress.Email:
string
The email of an existing custom from address you wish to use, which needs to be included within the request body
HtmlContent:
required
string
The HTML content of the campaign that lies between the opening <body> and the closing </body> only (the <body> tags themselves should not be used). This content needs to be included within the request body.
PlainTextContent:
required
string
The plain text content of the campaign, which needs to be included within the request body
ReplyAction:
string'Unset', 'WebMailForward', 'Webmail', 'Delete'
The required action to be taken when a reply to the campaign is sent by the recipient, which needs to be included within the request body
ReplyToAddress:
string
The email address that you would like replies to be forwarded to, which needs to be included within the request body

Examples


Result Format


Documentation

This operation can be used to create a new campaign within your account. You are able to create both HTML and plain text versions of the campaign. If you don't specify a reply action, then 'Unset' is the default setting that you'll see in the result. If you're using a 'reply to address', then replies will get stored both in-app and will also go to the 'reply to address' specified. This is also true of the 'WebMailForward' and 'WebMail' settings and thus you will not need to set these. If you don't want replies to be stored in-app then set the reply action to 'Delete' (thus they will be deleted). If you're using a 'reply to address' then replies will still go there.