{"_id":"55eda104a872a80d00acffa7","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"},"editedParams":true,"project":"55dd9f2e0efd5821000d54d9","__v":6,"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,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-07T14:36:52.727Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 3,\n  \"name\": \"Directions to Conference.pdf\",\n  \"fileName\": \"/cmpdoc/5/0/7/4/7/files/3_directions-to-conference.pdf\",\n  \"fileSize\": 24225,\n  \"dateCreated\": \"2015-11-24T11:48:38.397\",\n  \"dateModified\": \"2015-11-24T11:48:38.397\"\n}","name":""}]},"settings":"","examples":{"codes":[{"name":"","code":"var url = \"/v2/campaigns/1/attachments\";\nvar content = :::at:::\"{ id: 3 }\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\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    \"id\": 3\n}","language":"json"},{"code":"$content = [\n    'id' => '3'\n];\n$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/campaigns/1/attachments\";\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($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"auth":"required","params":[{"_id":"55eda37aec4c3e3900b75669","ref":"","in":"body","required":true,"desc":"The ID of the document, which needs to be included within the request body","default":"","type":"int","name":"ID"},{"_id":"5739bb891f4b740e00b06de4","ref":"","in":"body","required":false,"desc":"The name of the document, which goes within the request body","default":"","type":"string","name":"Name"},{"_id":"5739bb891f4b740e00b06de3","ref":"","in":"body","required":false,"desc":"The file name (path) of the document, which goes within the request body","default":"","type":"string","name":"FileName"},{"_id":"5739bb891f4b740e00b06de2","ref":"","in":"body","required":false,"desc":"The size in bytes of the document, which goes within the request body","default":"","type":"int","name":"FileSize"},{"_id":"5739bb891f4b740e00b06de1","ref":"","in":"body","required":false,"desc":"The date and time the document was first uploaded to the system, which goes within the request body","default":"","type":"datetime","name":"DateCreated"},{"_id":"5739bb891f4b740e00b06de0","ref":"","in":"body","required":false,"desc":"The date and time the document was last modified within the system, which goes within the request body","default":"","type":"datetime","name":"DateModified"},{"_id":"57f62d3e2da80e2000790806","ref":"","in":"path","required":true,"desc":"The ID of the campaign, which needs to be included within the URL","default":"","type":"int","name":"CampaignID"}],"url":"/v:version/campaigns/[CampaignID]/attachments"},"isReference":false,"order":7,"body":"This operation adds a document to a campaign as an attachment. The document can be no greater than 512KB in size.\n\nYou will require the permission to allow attachments to be sent with campaigns enabled on your account before you can use this feature.","excerpt":"Adds a document to a campaign as an attachment","slug":"add-campaign-attachment","type":"endpoint","title":"Add campaign attachment"}

postAdd campaign attachment

Adds a document to a campaign as an attachment

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

ID:
required
integer
The ID of the document, which needs to be included within the request body
Name:
string
The name of the document, which goes within the request body
FileName:
string
The file name (path) of the document, which goes within the request body
FileSize:
integer
The size in bytes of the document, which goes within the request body
DateCreated:
datetime
The date and time the document was first uploaded to the system, which goes within the request body
DateModified:
datetime
The date and time the document was last modified within the system, which goes within the request body

Examples


Result Format


Documentation

This operation adds a document to a campaign as an attachment. The document can be no greater than 512KB in size. You will require the permission to allow attachments to be sent with campaigns enabled on your account before you can use this feature.