Skip to main content
PATCH
/
v2
/
organizations
/
{orgId}
/
users
/
{userId}
Update a user
curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/users/{userId} \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "status": "success",
  "data": {
    "id": 1,
    "email": "john@example.com",
    "timeZone": "America/New_York",
    "weekStart": "Monday",
    "hideBranding": false,
    "createdDate": "2022-01-01T00:00:00Z",
    "profile": {
      "id": 1,
      "organizationId": 1,
      "userId": 1,
      "username": "john_doe"
    },
    "username": "john_doe",
    "name": "John Doe",
    "emailVerified": "2022-01-01T00:00:00Z",
    "bio": "I am a software developer",
    "avatarUrl": "https://example.com/avatar.jpg",
    "appTheme": "light",
    "theme": "default",
    "defaultScheduleId": 1,
    "locale": "en-US",
    "timeFormat": 12,
    "brandColor": "#ffffff",
    "darkBrandColor": "#000000",
    "allowDynamicBooking": true,
    "verified": true,
    "invitedTo": 1,
    "metadata": {
      "key": "value"
    }
  }
}

Headers

​
Authorization
string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
orgId
number
required
​
userId
number
required

Body

application/json

The body is of type object.

Response

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

"success"

​
data
object
required