{"_id":"560011c56932a00d00ba7b47","__v":2,"category":{"_id":"55f036d02911b72100482cd7","__v":4,"pages":["56000ae91503430d007cc730","56000f150c703d1900953009","560011c56932a00d00ba7b47","560017ac1503430d007cc749"],"version":"55dd9f4dab0e4d210045aae9","project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:40:32.091Z","from_sync":false,"order":9,"slug":"image-folders","title":"Image folders"},"parentDoc":null,"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,"editedParams2":true,"project":"55dd9f2e0efd5821000d54d9","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T14:18:45.439Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/image-folders/5\";\nvar content = :::at:::\"{ name: \"\"Product images\"\" }\";\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}","name":""},{"code":"{ \n  \"name\": \"Product images\"\n}","language":"json"},{"code":"$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/image-folders/5\";\n$content['Name'] = 'Product images';\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"}]},"method":"post","results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\": 6,\n  \"name\": \"Product images\",\n  \"childFolders\": null\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56000b631503430d007cc732","ref":"","in":"path","required":true,"desc":"The ID of an existing image folder to add the new campaign image to, which needs to be included within the URL","default":"","type":"int","name":"ID"},{"_id":"56000c206932a00d00ba7b3b","ref":"","in":"body","required":true,"desc":"The name of the folder being created. This needs to be included within the request body.","default":"","type":"string","name":"Name"}],"url":"/v:version/image-folders/[ID]"},"isReference":false,"order":0,"body":"This operation can be used to create a new campaign image folder within an existing campaign image folder, whilst child folders can also be created to nest within it.\n\nPlease note that the root image folder ID is 0.","excerpt":"Creates a new campaign image folder","slug":"create-image-folder","type":"endpoint","title":"Create image folder"}

postCreate image folder

Creates a new campaign image folder

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of an existing image folder to add the new campaign image to, which needs to be included within the URL

Body Params

Name:
required
string
The name of the folder being created. This needs to be included within the request body.

Examples


Result Format


Documentation

This operation can be used to create a new campaign image folder within an existing campaign image folder, whilst child folders can also be created to nest within it. Please note that the root image folder ID is 0.