Delete a managed user

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

Try it

Delete a managed user

cURL

curl --request DELETE \
  --url https://api.cal.com/v2/oauth-clients/{clientId}/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-cal-secret-key: <x-cal-secret-key>'

200

{
  "status": "success",
  "data": {
    "id": 1,
    "email": "[e-mail]",
    "username": "alice",
    "name": "alice",
    "bio": "bio",
    "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",
    "metadata": {
      "key": "value"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-cal-secret-key · string · required

OAuth client secret key

Path Parameters

clientId · string · required

userId · number · required

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes

data. id · number · required

Example:

1

data. email · string · required

Example:

"[e-mail]"

data. username · string | null · required

Example:

"alice"

data. name · string | null · required

Example:

"alice"

data. bio · string | null · required

Example:

"bio"

data. timeZone · string · required

Example:

"America/New_York"

data. weekStart · string · required

Example:

"Sunday"

data. createdDate · string · required

Example:

"2024-04-01T00:00:00.000Z"

data. timeFormat · number | null · required

Example:

12

data. defaultScheduleId · number | null · required

Example:

null

data. 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"

data. avatarUrl · string | null

URL of the user's avatar image

Example:

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

data. metadata · object

Example:

{ "key": "value" }