Update a Person

Update details for a person, by ID.

Specify the person ID in the personId parameter in the URI. Only an admin can update a person details.

Include all details for the person. This action expects all user details to be present in the request. A common approach is to first GET the person's details, make changes, then PUT both the changed and unchanged values.

You're not logged in. to run the demo.

Request Headers

Content-type application/json; charset=utf-8

Request Parameters

Name Type Description
emails string[]

Email addresses of the person

displayName string

Full name of the person

firstName string

First name of the person

lastName string

Last name of the person

avatar string

URL to the person's avatar in PNG format

orgId string

ID of the organization to which this person belongs

roles string[]

Roles of the person

licenses string[]

Licenses allocated to the person

Request Parameters

Name Type Your values
emails string[] Separate multiple values with commas
displayName string
firstName string
lastName string
avatar string
orgId string
roles string[] Separate multiple values with commas
licenses string[] Separate multiple values with commas

Response Codes




The request was invalid or cannot be otherwise served. An accompanying error message will explain further.


Authentication credentials were missing or incorrect.


The request is understood, but it has been refused or access is not allowed.


The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.


The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.


Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.


Something went wrong on the server.


Server is overloaded with requests. Try again later.