{"_id":"56c419d4bc41330d009f2601","parentDoc":null,"user":"56b98db7bb36440d0001f492","category":{"_id":"56c4181cc4796b0d007ef039","version":"56bc8e689afb8b0d00d62dd2","__v":26,"project":"56bc8e679afb8b0d00d62dcf","pages":["56c4192dbc41330d009f25fd","56c4196434df460d00c2bece","56c419814f0aed1700afaba6","56c4198dbc41330d009f25ff","56c419962e75e01700986053","56c4199f54b6030d00ec29a4","56c419a8bb64720d00552b8b","56c419b1bb64720d00552b8d","56c419b92d97560d00e23cf9","56c419c64040602b0064cea3","56c419d4bc41330d009f2601","56c419de70187b17005f43b9","56c419ea6063071700500cfe","56c419fa54b6030d00ec29a6","56c41a096063071700500d00","56c41a1834df460d00c2bed0","56c41a773d30210d00ea8517","56c41a86c4796b0d007ef03e","56c41a904f0aed1700afaba8","56c41a9fbc41330d009f2603","56c41aaa521f350d00d348fe","56c41abb4040602b0064cea5","56c41ad24040602b0064cea7","56c41ade48213b1700af6e28","56c41aeb3d30210d00ea8519","56c41af948213b1700af6e2a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:04.339Z","from_sync":false,"order":2,"slug":"users","title":"Users"},"__v":8,"project":"56bc8e679afb8b0d00d62dcf","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:57:24.341Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"[block:api-header]\n{\n  \"type\": \"patch\",\n  \"title\": \"/users/lists/{id}\"\n}\n[/block]\nAllows you to change the name, tag, and location for a Buddy UserList.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var options = {\\n\\tname: \\\"The Name\\\",\\n\\tlocation: \\\"47.1, -121.292\\\",\\n\\ttag: \\\"Some useful tag\\\"\\n};\\n\\nBuddy.patch('/users/lists/my_id',\\n\\t\\toptions,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\",\n      \"name\": null\n    },\n    {\n      \"code\": \"NSDictionary *params = :::at:::{\\n\\t\\t\\[email protected]\\\"name\\\": @\\\"The Name\\\",\\n\\t\\t\\[email protected]\\\"location\\\": BPCoordinateMake(47.1, -121.292),\\n\\t\\t\\[email protected]\\\"tag\\\": @\\\"Some useful tag\\\"\\n\\t\\t};\\n\\n[Buddy PATCH:@\\\"/users/lists/my_id\\\" parameters:params class:[BPUser class] callback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Map<String, Object> parameters = new HashMap<String, Object>();\\nparameters.put(\\\"name\\\", \\\"The Name\\\");\\nparameters.put(\\\"location\\\", myLocation);\\nparameters.put(\\\"tag\\\", \\\"Some useful tag\\\");\\n\\nBuddy.<User>patch(\\\"/users/lists/my_id\\\", parameters, new BuddyCallback<User>(User.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<User> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var options = new {\\n\\t\\t\\tname = \\\"The Name\\\",\\n\\t\\t\\tlocation = new BuddyGeoLocation(47.1, -122.3),\\n\\t\\t\\ttag = \\\"Some useful tag\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.PatchAsync<User>(\\\"/users/lists/my_id\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Path Parameters\n\nThese parameters should be specified as part of the HTTP path.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"0-1\": \"The ID of the userlist to update.\",\n    \"0-2\": \"buddyId\",\n    \"0-3\": \"Required\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"1-0\": \"location\",\n    \"2-0\": \"tag\",\n    \"0-1\": \"The new name for the User List.\",\n    \"1-1\": \"A new location for the User List.\",\n    \"2-1\": \"Metadata associated with the User List.\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"0-3\": \"Optional\",\n    \"1-3\": \"Optional\",\n    \"2-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 200,\\n  \\\"request_id\\\": \\\"54762a6b34cab11b2c28833f\\\",\\n  \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"update-userlist","type":"basic","title":"Update UserList"}
[block:api-header] { "type": "patch", "title": "/users/lists/{id}" } [/block] Allows you to change the name, tag, and location for a Buddy UserList. [block:code] { "codes": [ { "code": "var options = {\n\tname: \"The Name\",\n\tlocation: \"47.1, -121.292\",\n\ttag: \"Some useful tag\"\n};\n\nBuddy.patch('/users/lists/my_id',\n\t\toptions,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript", "name": null }, { "code": "NSDictionary *params = @{\n\t\t\[email protected]\"name\": @\"The Name\",\n\t\t\[email protected]\"location\": BPCoordinateMake(47.1, -121.292),\n\t\t\[email protected]\"tag\": @\"Some useful tag\"\n\t\t};\n\n[Buddy PATCH:@\"/users/lists/my_id\" parameters:params class:[BPUser class] callback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Map<String, Object> parameters = new HashMap<String, Object>();\nparameters.put(\"name\", \"The Name\");\nparameters.put(\"location\", myLocation);\nparameters.put(\"tag\", \"Some useful tag\");\n\nBuddy.<User>patch(\"/users/lists/my_id\", parameters, new BuddyCallback<User>(User.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<User> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var options = new {\n\t\t\tname = \"The Name\",\n\t\t\tlocation = new BuddyGeoLocation(47.1, -122.3),\n\t\t\ttag = \"Some useful tag\"\n\t\t};\n\nvar result = await Buddy.PatchAsync<User>(\"/users/lists/my_id\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Path Parameters These parameters should be specified as part of the HTTP path. [block:parameters] { "data": { "0-0": "id", "0-1": "The ID of the userlist to update.", "0-2": "buddyId", "0-3": "Required" }, "cols": 4, "rows": 1 } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "name", "1-0": "location", "2-0": "tag", "0-1": "The new name for the User List.", "1-1": "A new location for the User List.", "2-1": "Metadata associated with the User List.", "0-2": "string", "1-2": "string", "2-2": "string", "0-3": "Optional", "1-3": "Optional", "2-3": "Optional" }, "cols": 4, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"request_id\": \"54762a6b34cab11b2c28833f\",\n \"success\": true\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]