{"_id":"56c419b92d97560d00e23cf9","user":"56b98db7bb36440d0001f492","__v":8,"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"},"parentDoc":null,"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":["591f154221d2ff0f00cf5a1a"],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:56:57.877Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":8,"body":"[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"/users/lists\"\n}\n[/block]\nCreate a UserList.  A UserList can contain either user IDs or nested UserList IDs (e.g. a list of lists).\n\nA UserList can be used with the message and push notification APIs.\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\\treadPermissions: \\\"App\\\",\\n\\twritePermissions: \\\"User\\\"\\n};\\n\\nBuddy.post('/users/lists',\\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\\[email protected]\\\"readPermissions\\\": @\\\"App\\\",\\n\\t\\t\\[email protected]\\\"writePermissions\\\": @\\\"User\\\"\\n\\t\\t};\\n\\n[Buddy POST:@\\\"/users/lists\\\" 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\\\");\\nparameters.put(\\\"readPermissions\\\", \\\"App\\\");\\nparameters.put(\\\"writePermissions\\\", \\\"User\\\");\\n\\nBuddy.<User>post(\\\"/users/lists\\\", 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\\treadPermissions = \\\"App\\\",\\n\\t\\t\\twritePermissions = \\\"User\\\"\\n\\t\\t};\\n\\nvar result = await Buddy.PostAsync<UserList>(\\\"/users/lists\\\", options);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\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    \"0-1\": \"The name of the userList.\",\n    \"1-0\": \"location\",\n    \"1-1\": \"A location value, passed as a string in the format \\\"{latitude},{longitude}\\\" (e.g. \\\"47.1,-121.292\\\").\",\n    \"2-0\": \"tag\",\n    \"2-1\": \"A string value to attach to this object. This value will be returned with the object as a property called tag.\",\n    \"3-0\": \"readPermissions\",\n    \"3-1\": \"Specifies who can view this item. Values are User, only the user that created the value can view it, or App, meaning any app code can view the value.\",\n    \"4-0\": \"writePermissions\",\n    \"4-1\": \"Specifies who can modify this item. Values are User, only the user that created the value can view it and modify it, or App, meaning any app code can view and modify the value.\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"3-2\": \"string\",\n    \"4-2\": \"string\",\n    \"0-3\": \"Required\",\n    \"1-3\": \"Optional\",\n    \"2-3\": \"Optional\",\n    \"3-3\": \"Optional\",\n    \"4-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status\\\": 201,\\n  \\\"result\\\": {\\n    \\\"name\\\": \\\"my list\\\",\\n    \\\"readPermissions\\\": \\\"User\\\",\\n    \\\"writePermissions\\\": \\\"User\\\",\\n    \\\"id\\\": \\\"blv.DgbbbjgjDJHm\\\",\\n    \\\"created\\\": /Date(12412412412)/,\\n    \\\"lastModified\\\": /Date(12412412412)/\\n  },\\n  \\\"request_id\\\": \\\"5477ea51-da8e-46f3-833d-ca1a253b5333\\\",\\n  \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"create-userlist","type":"basic","title":"Create UserList"}
[block:api-header] { "type": "post", "title": "/users/lists" } [/block] Create a UserList. A UserList can contain either user IDs or nested UserList IDs (e.g. a list of lists). A UserList can be used with the message and push notification APIs. [block:code] { "codes": [ { "code": "var options = {\n\tname: \"The Name\",\n\tlocation: \"47.1, -121.292\",\n\ttag: \"Some useful tag\",\n\treadPermissions: \"App\",\n\twritePermissions: \"User\"\n};\n\nBuddy.post('/users/lists',\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\[email protected]\"readPermissions\": @\"App\",\n\t\t\[email protected]\"writePermissions\": @\"User\"\n\t\t};\n\n[Buddy POST:@\"/users/lists\" 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\");\nparameters.put(\"readPermissions\", \"App\");\nparameters.put(\"writePermissions\", \"User\");\n\nBuddy.<User>post(\"/users/lists\", 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\treadPermissions = \"App\",\n\t\t\twritePermissions = \"User\"\n\t\t};\n\nvar result = await Buddy.PostAsync<UserList>(\"/users/lists\", options);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "name", "0-1": "The name of the userList.", "1-0": "location", "1-1": "A location value, passed as a string in the format \"{latitude},{longitude}\" (e.g. \"47.1,-121.292\").", "2-0": "tag", "2-1": "A string value to attach to this object. This value will be returned with the object as a property called tag.", "3-0": "readPermissions", "3-1": "Specifies who can view this item. Values are User, only the user that created the value can view it, or App, meaning any app code can view the value.", "4-0": "writePermissions", "4-1": "Specifies who can modify this item. Values are User, only the user that created the value can view it and modify it, or App, meaning any app code can view and modify the value.", "0-2": "string", "1-2": "string", "2-2": "string", "3-2": "string", "4-2": "string", "0-3": "Required", "1-3": "Optional", "2-3": "Optional", "3-3": "Optional", "4-3": "Optional" }, "cols": 4, "rows": 5 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 201,\n \"result\": {\n \"name\": \"my list\",\n \"readPermissions\": \"User\",\n \"writePermissions\": \"User\",\n \"id\": \"blv.DgbbbjgjDJHm\",\n \"created\": /Date(12412412412)/,\n \"lastModified\": /Date(12412412412)/\n },\n \"request_id\": \"5477ea51-da8e-46f3-833d-ca1a253b5333\",\n \"success\": true\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]