Sign in

v2

latestOpenAPI 3.0.12026-07-1371223.3 KB
Users

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.

put/settings/users/2026-03/{userId}

Path parameters

userIdstring required

Query parameters

idProperty'EMAIL' | 'USER_ID'

Request body

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

primaryTeamIdstring

The user's primary team.

roleIdstring

The user's role.

secondaryTeamIdsstring[]

The user's additional teams.

Response

successful operation

emailstring required

The user's email.

firstNamestring

The user's first name.

idstring required

The user's unique ID.

lastNamestring

The user's last name.

primaryTeamIdstring

The user's primary team

roleIdstring

The user's role.

roleIdsstring[] required

A list of role IDs assigned to the user.

secondaryTeamIdsstring[]

The user's additional teams.

sendWelcomeEmailboolean

Whether a welcome email was sent to the user. This value will only be populated in response to a provisioning request. Subsequent queries will be false.

superAdminboolean required

Whether the user has super admin privileges.