Modifies a user
Modifies a user identified by userId. userId refers to the user’s ID by default, or optionally email as specified by the IdProperty query param.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the user to update.
Query Parameters
Specifies the property to use for identifying the user. Valid values are 'USER_ID' or 'EMAIL'.
EMAIL, USER_ID Body
The first name of the user. It is a string value.
The last name of the user. It is a string value.
The identifier for the user's primary team. It is a string value.
The identifier for the user's role. It is a string value.
An array of seat names associated with the user. Each item in the array is a string.
An array of identifiers for the user's secondary teams. Each item in the array is a string.
Response
successful operation
The email address of the user. This is a required field and must be unique.
The unique identifier for the user, represented as a string.
An array of strings representing the IDs of the roles assigned to the user. This is a required field.
A boolean indicating whether the user has super admin privileges. This is a required field.
The first name of the user, represented as a string.
The last name of the user, represented as a string.
The ID of the primary team to which the user belongs, represented as a string.
A string representing a single role ID assigned to the user.
An array of strings representing the names of seats assigned to the user.
An array of strings representing the IDs of secondary teams to which the user is associated.
A boolean indicating whether a welcome email should be sent to the user.