PATCH
/
v2
/
organizations
/
{orgId}
/
users
/
{userId}
/
schedules
/
{scheduleId}
curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "One-on-one coaching",
  "timeZone": "Europe/Rome",
  "availability": [
    {
      "days": [
        "Monday",
        "Tuesday"
      ],
      "startTime": "09:00",
      "endTime": "10:00"
    }
  ],
  "isDefault": true,
  "overrides": [
    {
      "date": "2024-05-20",
      "startTime": "12:00",
      "endTime": "14:00"
    }
  ]
}'
{
  "status": "success",
  "data": {
    "id": 254,
    "ownerId": 478,
    "name": "Catch up hours",
    "timeZone": "Europe/Rome",
    "availability": [
      {
        "days": [
          "Monday",
          "Tuesday"
        ],
        "startTime": "17:00",
        "endTime": "19:00"
      },
      {
        "days": [
          "Wednesday",
          "Thursday"
        ],
        "startTime": "16:00",
        "endTime": "20:00"
      }
    ],
    "isDefault": true,
    "overrides": [
      {
        "date": "2024-05-20",
        "startTime": "18:00",
        "endTime": "21:00"
      }
    ]
  },
  "error": {}
}

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

​
userId
number
required
​
scheduleId
number
required

Body

application/json
​
name
string
Example:

"One-on-one coaching"

​
timeZone
string
Example:

"Europe/Rome"

​
availability
object[]
Example:
[
  {
    "days": ["Monday", "Tuesday"],
    "startTime": "09:00",
    "endTime": "10:00"
  }
]
​
isDefault
boolean
Example:

true

​
overrides
object[]
Example:
[
  {
    "date": "2024-05-20",
    "startTime": "12:00",
    "endTime": "14:00"
  }
]

Response

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

"success"

​
data
object
required
​
error
object

Was this page helpful?

Suggest editsRaise issue