{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups/update.json","auth":"required","examples":{"codes":[{"code":"","name":"","language":"json"}]},"method":"put","params":[{"name":"groupName","type":"string","default":"","desc":"The name of the group","required":true,"in":"body","ref":"","_id":"5593de970e82e81700334e2d"},{"name":"adminEmails","type":"string","default":"","desc":"The email address of the group administrator","required":false,"in":"body","ref":"","_id":"5593de970e82e81700334e2c"},{"name":"configName","type":"string","default":"","desc":"The configuration name for the group","required":false,"in":"body","ref":"","_id":"5593de970e82e81700334e2b"},{"name":"parentName","type":"string","default":"","desc":"The name of the parent group","required":false,"in":"body","ref":"","_id":"5593de970e82e81700334e2a"},{"name":"description","type":"string","default":"","desc":"Additional description about the group","required":false,"in":"body","ref":"","_id":"5593de970e82e81700334e29"},{"name":"bgColor","type":"string","default":"","desc":"The background color of the group","required":false,"in":"body","ref":"","_id":"559431520c33bd0d0005959e"},{"name":"textColor","type":"string","default":"","desc":"The text color of the group","required":false,"in":"body","ref":"","_id":"559431520c33bd0d0005959d"},{"name":"newGroupName","type":"string","default":"","desc":"The new name for the group","required":true,"in":"body","ref":"","_id":"559433965c9eaa2300a862c5"}],"results":{"codes":[{"language":"json","code":"{\n\"restResponseVO\":\n { \n \"code\":200\n \"message\":\"Success\"\n \"reason\":\"\"\n \"generatedAt\":\"Dec-07-2015, 09:08 AM UTC\"\n \"currentPage\":null\n \"totalPages\":null\n }\n}","name":"","status":200}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"Edit","type":"endpoint","slug":"update-group","excerpt":"The update group API allows you to edit the details of an existing group. Only one group can be updated by a single API call. You are allowed to update groups for those you have access to modify.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"https://api.azuga.com/azuga-ws/v1/groups/update.json\",\n \"title\": \"Sample Request\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{ \\n \\\"groupName\\\":\\\"West Coast\\\",\\n \\\"newGroupName\\\":\\\"West Coast- Nevada\\\",\\n \\\"adminEmails\\\":\\\"kate.simons:::at:::azuga.com\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Sample Payload\"\n }\n ]\n}\n[/block]\n##API Response Explanation\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"0-0\": \"code\",\n \"0-1\": \"API Status Code\",\n \"1-1\": \"API Message\",\n \"2-1\": \"API generation timestamp in UTC\",\n \"3-1\": \"The reason for failure\",\n \"1-0\": \"message\",\n \"2-0\": \"generatedAt\",\n \"3-0\": \"reason\",\n \"4-0\": \"currentPage\",\n \"4-1\": \"The current page\",\n \"5-0\": \"totalPages\",\n \"5-1\": \"The total number of pages in the result\"\n },\n \"cols\": 2,\n \"rows\": 6\n}\n[/block]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"559433965c9eaa2300a862c4","githubsync":"","project":"55926c913735880d005f7c65","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"editedParams":true,"editedParams2":true,"parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["5593de970e82e81700334e28","559432b45c9eaa2300a862c0","559433965c9eaa2300a862c4","559433d75c9eaa2300a862c6","559435a85c9eaa2300a862cb"],"title":"GROUPS","slug":"groups","order":7,"from_sync":false,"reference":true,"_id":"5593dcaf0e82e81700334e25","version":"559286c6c39c4b2d00127a71","project":"55926c913735880d005f7c65","__v":5,"createdAt":"2015-07-01T12:27:27.124Z"},"user":"55926c39cf9cdb2100b57022","__v":2,"createdAt":"2015-07-01T18:38:14.372Z"}
putEdit
The update group API allows you to edit the details of an existing group. Only one group can be updated by a single API call. You are allowed to update groups for those you have access to modify.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Body Params
groupName:
required
string
The name of the group
adminEmails:
string
The email address of the group administrator
configName:
string
The configuration name for the group
parentName:
string
The name of the parent group
description:
string
Additional description about the group
bgColor:
string
The background color of the group
textColor:
string
The text color of the group
newGroupName:
required
string
The new name for the group