Sample - Slack Web API
POST/usergroups.update

Update a User Group

Updates an existing User Group's name, handle, description, default channels, or member count setting. Supply usergroup to identify the group, then include only the properties you want to change.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 6 body fields
tokenstringrequired
Authentication token with the `usergroups:write` scope.

Form data identifying the User Group and specifying the properties to update.

handlestringoptional
A mention handle. Must be unique among channels, users and User Groups.
descriptionstringoptional
A short description of the User Group.
channelsstringoptional
A comma separated string of encoded channel IDs for which the User Group uses as a default.
include_countbooleanoptional
Include the number of users in the User Group.
usergroupstringrequired
The encoded ID of the User Group to update.
namestringoptional
A name for the User Group. Must be unique among User Groups.

2 status codes
200Returns the updated User Group object, including its identifier, name, description, handle, channel configuration, and status metadata.
okbooleanrequired
Allowed:true
usergroupobjectrequired
defaultTypical error response
callstackstringoptional
Note: PHP callstack is only visible in dev/qa
errorstringrequired
Allowed:permission_deniednot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botuser_is_restrictedinvalid_arg_nameinvalid_array_arginvalid_charset
okbooleanrequired
Allowed:false

Error handling

usergroup is required and must identify the User Group to update. A supplied handle must be unique among channels, users, and User Groups, while name must be unique among User Groups; send an authentication token with the usergroups:write scope.