Basic
post/settings/users/2026-03
Request body
emailstring required
The user's email.
firstNamestring
The user's first name.
lastNamestring
The user's last name.
primaryTeamIdstring
The user's primary team.
roleIdstring
The user's role.
secondaryTeamIdsstring[]
The user's additional teams.
sendWelcomeEmailboolean required
Whether to send a welcome email.
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.