Sign in
Workspaces

Updates user role

Updates the workspace user role of a user that matches the parameters. Only succeeds if the requesting user has admin permissions in the workspace.

post/workspaces/{workspaceId}/users/role

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/workspaces/{workspaceId}/users/role
  • Auth: HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace.

Request body

emailstring required

Email of the user.

newRole'Admin' | 'DocMaker' | 'Editor' required

Example request

{
  "email": "hello@example.com"
}

Response

User's info that was updated.

roleChangedAtstring date-time required

Timestamp for when the user's role last changed in this workspace.

Example response

{
  "roleChangedAt": "2018-04-11T00:18:57.946Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.