Update User Properties

Update one or more properties of a user by providing an existing user ID and a new value for each property.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

User ID

Body Params
string

User password. At least 8 characters. Very weak password are rejected, such as '12345678', or 'password'

string

User first name

string

User last name

string

Required (if no sms_number is provided)

User valid email, must be unique.

string

Required (if no email is provided)

User phone number

user_role
object
string
Defaults to en_US

Locale ID

ID for the Locale to set for this user, must be one of the following: en_US, es_ES, es_CO, fr_FR, de_DE, nl_NL, no_NO, pt_PT, pt_BR, id_ID, da_DK, pl_PL.

default_team
object
groups
object
date-time

Date for when the user was invited, must be in the following format: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z] E.g. "2004-05-31T21:00:00"

date-time

Date for when the invitation was redeemed must be in the following format: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z] E.g. "2004-05-31T21:00:00"

string
Defaults to Etc/UTC

Timezone

Time zone for the user. Value must be one of TZ column of https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

teams
object
owned_locations
object
string

A value to uniquely identify this user.
If provided, it needs to be unique.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!