{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups","auth":"required","method":"post","params":[{"name":"name","type":"string","default":"","desc":"*Must be unique","required":true,"in":"body","ref":"","_id":"562a96b9d56bc30d00f0ca8c"},{"name":"default","type":"boolean","default":"false","desc":"Only a single group can be the default for an account.","required":false,"in":"body","ref":"","_id":"562a96b9d56bc30d00f0ca8b"},{"name":"parent_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"59cbd00af69087003a9ab99b"},{"name":"hierarchy","type":"string","default":"","desc":"A pipe delimited group hierarchy. Ex: \"Level 1|Level 2|Level 3\". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. If hierarchy is present, then all other attributes will be ignored. If an existing hierarchy is given, then the last group in the hierarchy will simply be returned and an error will not be raised.","required":false,"in":"body","ref":"","_id":"6070cfc9a7ac8401af049c3e"}],"results":{"codes":[{"status":201,"language":"json","code":"{  \n  \"id\":21312,\n  \"account_id\":122,\n  \"name\":\"New Group\",\n  \"default\":false,\n  \"created_at\":\"2015-05-28T15:20:39.331-05:00\",\n  \"updated_at\":\"2015-05-28T15:20:39.331-05:00\"\n}","name":""},{"status":422,"language":"json","code":"{\n  \"errors\": {\n    ...\n  }\n}"}]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"/groups","type":"endpoint","slug":"create-group","excerpt":"Creates a new group.","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"562a96b9d56bc30d00f0ca8a","editedParams2":true,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979","5ec5a01754009700689296af","5fdccde14e7e670026bf39e4","5fdcec63772996007b56bcca","5fe965032be3ac0020cfb386","5fe9664242f389001c1c67e8"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":44},"project":"54c0e51215af820d001a38a6","parentDoc":null,"__v":5,"category":{"sync":{"isSync":false,"url":""},"pages":["562a95b9c50ab20d003ef07a","562a96b9d56bc30d00f0ca8a","562a9710d75fd20d002f1220","562a974596b5f40d0026eb64","562a97d3d56bc30d00f0ca8e"],"title":"Groups","slug":"groups","order":18,"from_sync":false,"reference":true,"_id":"562a956c96b5f40d0026eb60","__v":5,"project":"54c0e51215af820d001a38a6","version":"54f8de4e4339bb1900c8bffb","createdAt":"2015-10-23T20:15:40.233Z"},"editedParams":true,"user":"54cba76f6d1eee0d00c33dee","createdAt":"2015-10-23T20:21:13.080Z","githubsync":""}

post/groups

Creates a new group.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
*Must be unique
default:
booleanfalse
Only a single group can be the default for an account.
parent_id:
integer
hierarchy:
string
A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. If hierarchy is present, then all other attributes will be ignored. If an existing hierarchy is given, then the last group in the hierarchy will simply be returned and an error will not be raised.

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}