CHchrt
/users

Update name

Changed on

Updates the caller's name in WorkOS and private user data. | (UserPrivateDataNameUpdateReq) -> (UserPrivateData1)

patch/users/user_private_data/update_name/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/users/user_private_data/update_name/v1
  • Auth
    HTTP bearer

Request body

namestring required

Response

Successful Response

schema_version1 required
created_at_timestampstring date-time required
user_idstring required

Must be a string starting with user_

namestring nullable
primary_email_addressstring email nullable
phone_numberstring phone nullable
time_zonestring nullable

IANA time zone name (e.g. America/New_York).

_idstring required

Example response

{
  "time_zone": "America/New_York"
}

Changes