Set(Unset) a group member as admin

Set or unset a member as administrator of the group and return the member info.

is_admin must be sent as string true or false. Since v13 organization groups are rejected with 403.

Permission: System admin (is_staff) whose admin role grants can_manage_group. Admin roles with a restricted permission set (e.g. audit_admin, system_admin) receive 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier of a group

string
required
^[a-f0-9]{32}(@auth.local)$

The unique user id in the form [email protected]. This is not the email address of the user.

Body Params
string
enum
required

true = set as group admin, false = unset.

Allowed:
Responses

400

User is not a member of the group, or is_admin invalid.

403

Permission denied: the account is not a system admin, or its admin role lacks the required admin permission. Also returned for organization groups.

404

Group or user not found.

500

Internal server error.

Language
Credentials
Bearer
Account-Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json