Sign in
Deprecated: Platform / Managed Users

Update a managed user

<Warning>These endpoints are deprecated and will be removed in the future.</Warning>

patch/v2/oauth-clients/{clientId}/users/{userId}

Path parameters

clientIdstring required
userIdnumber required

Headers

x-cal-secret-keystring required

OAuth client secret key

Request body

emailstring
namestring
timeFormat12 | 24

Must be 12 or 24

defaultScheduleIdnumber
weekStart'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday'
timeZonestring
locale'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'
avatarUrlstring

URL of the user's avatar image

biostring

Bio

metadataobject

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 request

{
  "timeFormat": 12,
  "weekStart": "Monday",
  "locale": "en",
  "avatarUrl": "https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png",
  "bio": "I am a bio",
  "metadata": {
    "key": "value"
  }
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "email": "alice+cluo37fwd0001khkzqqynkpj3@example.com",
    "username": "alice",
    "name": "alice",
    "bio": "bio",
    "timeZone": "America/New_York",
    "weekStart": "Sunday",
    "createdDate": "2024-04-01T00:00:00.000Z",
    "timeFormat": 12,
    "locale": "en",
    "avatarUrl": "https://cal.com/api/avatar/2b735186-b01b-46d3-87da-019b8f61776b.png",
    "metadata": {
      "key": "value"
    }
  }
}

Changes

Changed in 2 of the 50 revisions of this API.4

  • v2946fc816b2902See the full diff
    • ○

      api tag Deprecated: Platform / Managed Users added

      api-tag-added

    • ○

      api tag Platform / Managed Users removed

      api-tag-removed

  • v2daa3e48bc03a2See the full diff
    • ○

      api tag Platform / Managed Users added

      api-tag-added

    • ○

      api tag Deprecated: Platform / Managed Users removed

      api-tag-removed

    This revision also has 46 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog