v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Groups

Add a user's role

🔑

Required OAuth scope: groups:write.

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

post/api/v2/groups/{groupId}/{role}/{userId}

Path parameters

groupIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the group.

role'admin' | 'analyst' | 'coach' | 'contributor' | 'editor' | 'learner' | 'user-admin' required

The role to add to the user.

userIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the user.

Headers

360-api-version'v2.0' required

The version of the API.

Response

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