get
https://try.count.ly/i/groups/update?api_key=api_key&args=args
Update an existing group
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
New group's data is provided in args parameter as stringified JSON. Key-value pairs in this JSON object is as follows:
| name/key | required? | type | description |
|---|---|---|---|
| _id | yes | yes | Group's DB id. Shown as GROUP_ID in endpoints results above. |
| name | yes | String | Name of the group |
| groupID | yes | String | ID of group. Typically name of group lowercased and special chars removed. Example: name: "Junior Developers (test)" groupID: "junior-developers-test" |
| global_admin | yes | Boolean | If group users are given global admin privileges. |
| admin_of | no | Array[String] | Array of app ids where group users are given admin privileges. |
| user_of | no | Array[String] | Array of app ids where group users are given user privileges. |
| users | no | Array[String] | Array of user ids to add to the group |
Here is an example of args object:
{
"_id": "GROUP_ID",
"name": "tester",
"groupID": "tester",
"global_admin": false,
"user_of": [
"58650a47cc2ed563c5ad964c" // APP ID
],
"users": [
"5d4290788c5581156db06f7f" // USER ID
]
}