Update my profile

PATCH /v2/me

Try it

Update my profile

cURL

curl --request PATCH \
  --url https://api.cal.com/v2/me \
  --header 'Authorization: <authorization>' \
  --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",
  "bio": "I am a bio",
  "metadata": {
    "key": "value"
  }
}
'

200

{
  "status": "success",
  "data": {
    "id": 123,
    "username": "<string>",
    "email": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "bio": "<string>",
    "timeFormat": 123,
    "defaultScheduleId": 123,
    "weekStart": "<string>",
    "timeZone": "<string>",
    "organizationId": 123,
    "organization": {
      "isPlatform": true,
      "id": 123
    }
  }
}

Headers

Authorization · string · required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

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, bn

Example:

"en"

avatarUrl · string

URL of the user's avatar image

Example:

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

bio · string

Bio

Example:

"I am a bio"

metadata · object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters.

Example:

{ "key": "value" }

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes

data. id · number · required

data. username · string · required

data. email · string · required

data. name · string | null · required

data. avatarUrl · string | null · required

data. bio · string | null · required

data. timeFormat · number · required

data. defaultScheduleId · number | null · required

data. weekStart · string · required

data. timeZone · string · required

data. organizationId · number | null · required

data. organization · object

Show child attributes

data.organization. isPlatform · boolean · required

data.organization. id · number · required