API Reference

Update Group

Use this request to rename, and/or change owner of a group.
In the request body, both parameters are optional. Only use the ones that you need to update:

  • new_owner is the new owner of the group, include the user's ID here. If you don't want to change the owner, remove this parameter because if you enter the current owner's ID here, you'll get an error "User xxx is already group owner".
  • new_group_name is the new name of your group. If you don't want to change the name, remove shi parameter because if you enter the current group name here you'll get an error "There is already a group with that name".
Path Params
integer
required
≥ 1

The ID of your team/organization. Numeric. Get it from Get Team. Contact your team admin, if you are not the admin.

integer
required
≥ 1

The ID of the group to query. Can be retrieved from the call List Groups in Your Team.

Body Params
string

The unique user_id in the form ...@auth.local. This is not the email address of the user.

string

The name of the group.

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json