usergroups update
POST {{baseUrl}}/usergroups.update
Update an existing User Group
Request Body
[{"name"=>"usergroup", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"handle", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"channels", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"include_count", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"name", "value"=>"<string>", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
token | string | (Required) Authentication token. Requires scope: usergroups:write | |
Content-Type | string |
RESPONSES
status: OK
{"ok":"\u003cboolean\u003e","usergroup":{"id":"\u003cstring\u003e","team_id":"\u003cstring\u003e","is_usergroup":"\u003cboolean\u003e","is_subteam":"\u003cboolean\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","handle":"\u003cstring\u003e","is_external":"\u003cboolean\u003e","date_create":"\u003cinteger\u003e","date_update":"\u003cinteger\u003e","date_delete":"\u003cinteger\u003e","auto_type":{},"auto_provision":"\u003cboolean\u003e","enterprise_subteam_id":"\u003cstring\u003e","created_by":"\u003cstring\u003e","updated_by":"\u003cstring\u003e","deleted_by":{},"prefs":{"channels":["\u003cstring\u003e","\u003cstring\u003e"],"groups":["\u003cstring\u003e","\u003cstring\u003e"]},"channel_count":"\u003cinteger\u003e","user_count":"\u003cinteger\u003e","users":["\u003cstring\u003e","\u003cstring\u003e"]}}