{"_id":"5b3b91b40d0d760003f43bf3","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":30,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-07-03T15:09:40.270Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"// Updating a preference that is in a category\n\nvar url = \"/v2/preference\";\nvar content = :::at:::\"\n      { id: 2,\n      privateName: \"\"Preference name\"\",\n      publicName: \"\"Preference name\"\",\n      order: 1,\n      isPublic: false,\n      categoryId: 14\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.PutAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}","language":"csharp"},{"language":"json","code":"{ \n  \"id\": 2, \n  \"privateName\": \"Preference name\", \n  \"publicName\": \"Preference name\",\n  \"order\": 1, \n  \"isPublic\": false,\n  \"categoryId\": 14 \n}"},{"language":"php","code":"// Updating a preference that is in a category\n\n$content = [];\n$content['id'] = 2\n$content['PublicName'] = 'Preference name';\n$content['PrivateName'] = 'Preference name';\n$content['Order'] = 1;\n$content['IsPublic'] = false;\n$content['CategoryId'] = 14;\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));"}]},"results":{"codes":[{"name":"","code":"{ id: 2,\n  publicName: 'Preference name',\n  privateName: 'Preference name',\n  isPreference: true,\n  order: 1,\n  isPublic: false,\n  categoryId: 14,\n  lastModified: '2018-07-04T09:39:48.3040402Z'\n}","language":"json","status":200}]},"settings":"","method":"put","auth":"required","params":[{"_id":"5b436e579f959c0003e3a1ed","ref":"","in":"body","required":true,"desc":"The ID of the preference or preference category that you want to update.","default":"","type":"int","name":"ID"},{"_id":"5b436e579f959c0003e3a1ec","ref":"","in":"body","required":false,"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":"5b436e579f959c0003e3a1eb","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":"","type":"string","name":"PrivateName"},{"_id":"5b436e579f959c0003e3a1ea","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":"5b436e579f959c0003e3a1e9","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":"5b436f1d5e8244000399d2e1","ref":"","in":"body","required":false,"desc":"For preference categories, the unique ID of the category that you want to update.","default":"Default for preferences: 0. Default for preference categories: null","type":"int","name":"CategoryID"}],"url":"/v:version/preference"},"isReference":false,"order":1,"body":"This operation updates the preference or preference category that has a given ID.","excerpt":"Updates a preference or preference category that has a given ID","slug":"update-preference","type":"endpoint","title":"Update preference"}

putUpdate preference

Updates a preference or preference category that has a given ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ID:
required
integer
The ID of the preference or preference category that you want to update.
PublicName:
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:
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.
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 preference categories, the unique ID of the category that you want to update.

Examples


Result Format


Documentation

This operation updates the preference or preference category that has a given ID.