Add a user's role

🔑

Required OAuth scope: groups:write.

Adds the given role to the given user in the given group.

This endpoint handles both the initial group membership and the subsequent assignment of additional roles.

  • If the user is not yet a member of the group, calling this endpoint will add the user to the group and assign the specified role.
  • If the user is already a member of the group, the provided role is appended to their current set of roles within that specific group, ensuring existing roles are not overwritten.
Path Params
string
required
^[a-fA-F0-9]{24}$

The unique ID of the group.

string
enum
required

The role to add to the user.

Allowed:
string
required
^[a-fA-F0-9]{24}$

The unique ID of the user.

Headers
string
enum
required

The version of the API.

Allowed:
Responses
204

Adds the given role to the given user in the given group.

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