{"_id":"55df0b2086ae7f0d00db4c25","project":"55dd9f2e0efd5821000d54d9","__v":2,"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"},"category":{"_id":"55e04764a44fae0d00214671","project":"55dd9f2e0efd5821000d54d9","pages":["561fb9a3ec2ab817009d1053","561fbcbfec2ab817009d105b","561fbe228a05d7230006ff31","561fbf8ccfc3610d00567311"],"version":"55dd9f4dab0e4d210045aae9","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:35:00.999Z","from_sync":false,"order":3,"slug":"address-books","title":"Address books"},"user":"55dd9841cafe7221002a4c62","parentDoc":null,"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-27T13:05:36.964Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/address-books/1\";\nvar content = :::at:::\"{ name: \"\"My Updated Address Book\"\", visibility: \"\"Private\"\" }\";\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.PutAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}"},{"code":"{\n  \"name\": \"My Updated Address Book\",\n  \"visibility\": \"Private\"\n}","language":"json"},{"code":"$content = [\n    'name' => 'My Updated Address Book',\n\t  'visibility' => 'Private'\n];\n\n$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/address-books/1\";\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, \"PUT\");\ncurl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"put","results":{"codes":[{"name":"","code":"{\n  \"id\": 1,\n  \"name\": \"My Updated Address Book\",\n  \"visibility\": \"Private\",\n  \"contacts\": 0\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"55ddbc1e746ace2b00dd6f38","ref":"","in":"body","required":true,"desc":"The name of the address book, which needs to be included within the request body. There is a limit of 128 characters.","default":"","type":"string","name":"Name"},{"_id":"55ddbc1e746ace2b00dd6f37","ref":"","in":"body","required":false,"desc":"All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to. This needs to be included within the request body.","default":"'Private', 'Public'","type":"string","name":"Visibility"},{"_id":"57f62af95cf2a02200798ff9","ref":"","in":"path","required":true,"desc":"The ID of the address book, which needs to be included within the URL","default":"","type":"int","name":"ID"}],"url":"/v:version/address-books/[ID]"},"isReference":false,"order":2,"body":"This operation updates a specified address book within your account. The information entered will replace any existing information for the address book in terms of its name and/or visibility.\n\nAddress book names have a limit of 128 characters.","excerpt":"Updates an address book by ID","slug":"update-address-book","type":"endpoint","title":"Update address book"}

putUpdate address book

Updates an address book by ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the address book, which needs to be included within the URL

Body Params

Name:
required
string
The name of the address book, which needs to be included within the request body. There is a limit of 128 characters.
Visibility:
string'Private', 'Public'
All address books are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to. This needs to be included within the request body.

Examples


Result Format


Documentation

This operation updates a specified address book within your account. The information entered will replace any existing information for the address book in terms of its name and/or visibility. Address book names have a limit of 128 characters.