PATCH
/
v2
/
oauth-clients
/
{clientId}
/
users
/
{userId}
curl --request PATCH \
  --url https://api.cal.com/v2/oauth-clients/{clientId}/users/{userId} \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "name": "<string>",
  "timeFormat": 12,
  "defaultScheduleId": 123,
  "weekStart": "Monday",
  "timeZone": "<string>",
  "locale": "en",
  "avatarUrl": "https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png"
}'
{
  "status": "success",
  "data": {
    "id": 1,
    "email": "[email protected]",
    "username": "alice",
    "name": "alice",
    "timeZone": "America/New_York",
    "weekStart": "Sunday",
    "createdDate": "2024-04-01T00:00:00.000Z",
    "timeFormat": 12,
    "defaultScheduleId": null,
    "locale": "en",
    "avatarUrl": "https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png"
  }
}

Path Parameters

​
clientId
string
required
​
userId
number
required

Body

application/json
​
email
string
​
name
string
​
timeFormat
enum<number>

Must be 12 or 24

Available options:
12,
24
Example:

12

​
defaultScheduleId
number
​
weekStart
enum<string>
Available options:
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
Example:

"Monday"

​
timeZone
string
​
locale
enum<string>
Available options:
ar,
ca,
de,
es,
eu,
he,
id,
ja,
lv,
pl,
ro,
sr,
th,
vi,
az,
cs,
el,
es-419,
fi,
hr,
it,
km,
nl,
pt,
ru,
sv,
tr,
zh-CN,
bg,
da,
en,
et,
fr,
hu,
iw,
ko,
no,
pt-BR,
sk,
ta,
uk,
zh-TW
Example:

"en"

​
avatarUrl
string

URL of the user's avatar image

Example:

"https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png"

Response

200 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Delete a managed userForce refresh tokens