{"_id":"5b1905b1b1a8ea00030e868e","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":"5b19051beece890003020163","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-06-07T10:12:43.234Z","from_sync":false,"order":13,"slug":"preferences","title":"Preferences"},"user":"5a251846c297dc0012e531cd","githubsync":"","__v":41,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-07T10:15:13.275Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{ id: 23,\n  publicName: 'Preferred contact method',\n  privateName: 'Preferred contact method',\n  isPreference: false,\n  order: 0,\n  isPublic: true,\n  categoryId: 0,\n  preferenceCount: 0,\n  created: '2018-07-04T09:39:48.3040402Z',\n  lastModified: '2018-07-04T09:39:48.3040402Z'\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/preference\";\n            var content = :::at:::\"{ \"\"publicName\"\": \"\"Preferred contact method\"\", \"\"privateName\"\": \"\"Preferred contact method\"\", \"\"isPreference\"\": false, \"\"isPublic\"\": true, \"\"order\"\": \"\"top\"\", \"\"categoryId\"\": null }\";\n            using (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.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n            }","language":"csharp"},{"language":"json","code":"{\n\t\"publicName\": \"Preferred contact method\",\n\t\"privateName\": \"Preferred contact method\",\n\t\"isPreference\": true,\n  \"isPublic\": true,\n  \"order\": 0,\n\t\"categoryId\": null\n}"},{"code":"$content = [];\n$content['PublicName'] = 'Preferred contact method';\n$content['PrivateName'] = 'Preferred contact method';\n$content['IsPreference'] = false;\n$content['Order'] = 'top'\n$content['IsPublic'] = true;\n$content['CategoryID'] = null;\n$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/preference/\";\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    );\n    curl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\n        curl_setopt(\n            $ch, CURLOPT_USERPWD,\n            $apiUsername . ':' . $apiPassword\n        );\n        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\n        curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"post","auth":"required","params":[{"_id":"5b190ad4eece890003020264","ref":"","in":"body","required":true,"desc":"The public name of the preference or the preference category. Contacts can see the public names of preferences in preference centres and signup forms.","default":"","type":"string","name":"PublicName"},{"_id":"5b190ad4eece890003020263","ref":"","in":"body","required":false,"desc":"The private name of the preference or the preference category. Contacts can't see private names in the preference centre or in signup forms.","default":"Default: PublicName string","type":"string","name":"PrivateName"},{"_id":"5b190ad4eece890003020262","ref":"","in":"body","required":false,"desc":"If this value is true, a new preference is created. If this value is false, a new preference category is created.","default":"Default: false","type":"boolean","name":"IsPreference"},{"_id":"5b190c56fa0e630003456fe2","ref":"","in":"body","required":false,"desc":"The position that you want the preference or the preference category to appear on the 'Contact preferences' page, starting from 0.","default":"integer, \"top\", or \"bottom\"","type":"string","name":"Order"},{"_id":"5b362bb7bb84cb0003b1d3b5","ref":"","in":"body","required":false,"desc":"For preferences, if this value is true, the preference is visible in signup forms and preference centres.","default":"Default: true","type":"boolean","name":"IsPublic"},{"_id":"5b190ad4eece890003020261","ref":"","in":"body","required":false,"desc":"For preferences, the unique ID of the preference category that you want to add the preference to.","default":"Default for preferences: 0. Default for preference categories: null","type":"int","name":"CategoryID"}],"url":"/v:version/preference"},"isReference":false,"order":0,"body":"This operation creates either a new preference or a new preference category.\n\n* Preferences that are inside the same category must have unique private names\n* Uncategorised preferences must have unique private names\n* All categories must have unique private names\n* Preferences and categories can have the same public names\n\n## Creating a preference outside of a category\n\n1. Set the value of the `isPreference` key to `true`\n2. Set the value of the `CategoryId` key to `null`\n\n## Creating a preference inside a category\n\n1. Set the value of the `isPreference` key to `true`\n2. Set the value of the `CategoryId` key to the ID of an existing category\n\n## Creating a preference category\n\n1. Set the value of the `isPreference` key to `false`\n2. Set the value of the `CategoryId` key to a unique integer","excerpt":"Creates a new preference or a new preference category","slug":"create-preference","type":"endpoint","title":"Create preference"}

postCreate preference

Creates a new preference or a new preference category

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

PublicName:
required
string
The public name of the preference or the preference category. Contacts can see the public names of preferences in preference centres and signup forms.
PrivateName:
stringDefault: PublicName string
The private name of the preference or the preference category. Contacts can't see private names in the preference centre or in signup forms.
IsPreference:
booleanDefault: false
If this value is true, a new preference is created. If this value is false, a new preference category is created.
Order:
stringinteger, "top", or "bottom"
The position that you want the preference or the preference category to appear on the 'Contact preferences' page, starting from 0.
IsPublic:
booleanDefault: true
For preferences, if this value is true, the preference is visible in signup forms and preference centres.
CategoryID:
integerDefault for preferences: 0. Default for preference categories: null
For preferences, the unique ID of the preference category that you want to add the preference to.

Examples


Result Format


Documentation

This operation creates either a new preference or a new preference category. * Preferences that are inside the same category must have unique private names * Uncategorised preferences must have unique private names * All categories must have unique private names * Preferences and categories can have the same public names ## Creating a preference outside of a category 1. Set the value of the `isPreference` key to `true` 2. Set the value of the `CategoryId` key to `null` ## Creating a preference inside a category 1. Set the value of the `isPreference` key to `true` 2. Set the value of the `CategoryId` key to the ID of an existing category ## Creating a preference category 1. Set the value of the `isPreference` key to `false` 2. Set the value of the `CategoryId` key to a unique integer