PATCH
/
users
/
{userId}
curl --request PATCH \
  --url https://api.cal.com/v1/users/{userId} \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "email@example.com",
  "username": "johndoe",
  "weekStart": "MONDAY",
  "brandColor": null,
  "darkBrandColor": null,
  "timeZone": "EUROPE/PARIS",
  "theme": "LIGHT",
  "timeFormat": "TWELVE",
  "locale": "FR"
}'

Authorizations

​
apiKey
string
query
required

Path Parameters

​
userId
integer
required

ID of the user to edit

Query Parameters

​
apiKey
string
required

Your API key

Body

application/json
Edit an existing attendee related to one of your bookings
​
email
string

Email that belongs to the user being edited

​
username
string

Username for the user being edited

​
brandColor
string

The user's brand color

​
darkBrandColor
string

The user's brand color for dark mode

​
weekStart
string

Start of the week. Acceptable values are one of [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

​
timeZone
string

The user's time zone

​
hideBranding
boolean

Remove branding from the user's calendar page

​
theme
string

Default theme for the user. Acceptable values are one of [DARK, LIGHT]

​
timeFormat
string

The user's time format. Acceptable values are one of [TWELVE, TWENTY_FOUR]

​
locale
string

The user's locale. Acceptable values are one of [EN, FR, IT, RU, ES, DE, PT, RO, NL, PT_BR, ES_419, KO, JA, PL, AR, IW, ZH_CH, ZH_TW, CS, SR, SV, VI]

​
avatar
string

The user's avatar, in base64 format

Response

200

OK, user edited successfully

Was this page helpful?

Suggest editsRaise issue