Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
users

Update user

Update the details of a user.

put/v1/users

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Request body

emailstring required

The user's email address.

protectedUserboolean required

The protection status of the user.

Example request

{
  "email": "corotest@corotest.com",
  "protectedUser": true
}

Response

Success

idstring

The unique identifier of the user.

emailstring

The user’s email address.

namestring

The user’s full name.

protectedUserboolean

The protection status of the user.

Example response

{
  "id": "62ff9653efef4b3ae04ab25e",
  "email": "test@test.com",
  "name": "Harry Owen"
}