Update a Schedule

put

https://crm-api.portals.care/schedules/{id}

Updates an existing schedule's details, such as its label, time slots, or overrides.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier of the schedule to update.

Body Params

Represents a complete schedule, including regular weekly slots and specific date overrides.

_id

string

The unique identifier for the schedule.

organization

string

The ID of the organization this schedule belongs to.

label

string

A human-readable name for the schedule (e.g., "Dr. Doe's Clinic Hours").

slots

array of objects

An array of regular weekly time slots.

slots

startDate

date-time

The date from which this schedule is effective.

endDate

date-time

The date until which this schedule is effective.

slotDuration

number

The duration of each appointment slot in minutes. This can override a service's default duration.

overrides

array of objects

A list of specific date-based exceptions to the regular schedule.

overrides

provider

object

Information about the provider associated with this schedule.

icsLink

string

A URL to an iCal (.ics) file for this schedule.

timezone

string

The timezone for the schedule (e.g., "America/New_York").

createdAt

date-time

The timestamp when the schedule was created.

updatedAt

date-time

The timestamp when the schedule was last updated.

Headers

organization

string

required

Your unique Organization ID.

Response

200

The schedule was updated successfully.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!