Skip to main content
PATCH
/
users
/
{user}
Update user
curl --request PATCH \
  --url https://api.example.com/users/{user} \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "show_email": true,
  "unit": 123,
  "userTypes": [
    123
  ],
  "title": "<string>",
  "phone": "<string>",
  "show_phone": true,
  "alt_phone": "<string>",
  "show_alt_phone": true,
  "specialties": [
    123
  ],
  "birthday": "<string>",
  "admin": 0,
  "settings": {
    "show_birthdays": "<string>",
    "birthdays_optout": true,
    "privatemsg": [
      123
    ],
    "language": "<string>",
    "timezone": "<string>",
    "text_to_speech_enabled": true
  },
  "meta_field_0": "<string>",
  "meta_field_1": "<string>",
  "meta_field_2": "<string>",
  "meta_field_3": "<string>",
  "meta_field_4": "<string>"
}
'

Path Parameters

user
integer
required

User ID

Body

application/json
first_name
string
Required string length: 2 - 255
last_name
string
Required string length: 2 - 255
email
string<email> | null
show_email
boolean
unit
integer | null
userTypes
integer[]

IDs of user types

title
string
Maximum string length: 255
phone
string
Maximum string length: 255
show_phone
boolean
alt_phone
string
Maximum string length: 255
show_alt_phone
boolean
specialties
integer[]

IDs of user specialty categories

birthday
string | null

Birthdate string or null

admin
integer
Required range: 0 <= x <= 1
settings
object
meta_field_0
string | null

Custom meta field 0

Maximum string length: 255
meta_field_1
string | null

Custom meta field 1

Maximum string length: 255
meta_field_2
string | null

Custom meta field 2

Maximum string length: 255
meta_field_3
string | null

Custom meta field 3

Maximum string length: 255
meta_field_4
string | null

Custom meta field 4

Maximum string length: 255

Response

User updated