Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

AppointmentSchedules.update

Modifies AppointmentSchedule or AppointmentSchedules with given id(s)

patch/entities/AppointmentSchedules/{id}

Path parameters

idstring uuid required

ID of AppointmentSchedule to update

Query parameters

validation-levelinteger

Specify validation level of AppointmentSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

appointment_descriptionstring

Description applied to appointments booked through this schedule.

appointment_durationnumber double

Duration of each booked appointment.

appointment_locationstring

Location applied to appointments booked through this schedule.

appointment_location_type0 | 1 | 2

How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting).

Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom

appointment_owner_idstring uuid

Id of the user receiving the booking.

appointment_subjectstring

Subject applied to appointments booked through this schedule.

appointment_subject_uses_schedule_nameboolean

When true, booked appointments use the schedule_name as their subject instead of appointment_subject.

appointment_type_idstring uuid

Id of the appointment type.

availability_tzidstring

IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.

buffer_time_afterinteger

Minutes of buffer reserved after each booked appointment.

buffer_time_beforeinteger

Minutes of buffer reserved before each booked appointment.

confirmation_page_type0 | 1

What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL).

Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl

confirmation_page_urlstring

Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect.

is_enabledboolean

Master switch for the schedule. Disabled schedules do not accept new bookings.

minimum_notice_timeinteger

Minimum notice in hours required before a slot can be booked.

namestring

Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name.

owner_idstring uuid

Id of the schedule owner.

planning_day_offsetinteger

For rolling planning: how many days ahead the schedule remains bookable.

planning_period_fromstring date

For fixed-range planning: first date bookings are accepted for.

planning_period_tostring date

For fixed-range planning: last date bookings are accepted for.

planning_type0 | 1 | 2

How far ahead bookings are accepted (e.g. RollingDays, FixedRange).

Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period

reminder_email_enabledboolean

True when a reminder email is sent to invitees ahead of the booked appointment.

reminder_email_offsetinteger

Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type.

reminder_email_offset_type0 | 1 | 2 | 3

Unit of reminder_email_offset (e.g. Minutes, Hours, Days).

Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week

reply_company_email_idstring uuid

Id of the reply company email.

schedule_namestring

Public-facing name of the schedule, shown to bookers on the booking page.

time_incrementinteger

Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45).

type0 | 1

Schedule type (e.g. one-on-one or round-robin).

Integer enum value: 0 - OneToOne, 1 - Group

urlstring

Public URL slug of the schedule, used to share the booking page.

availability_dataobject

Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone.

Example request

{
  "appointment_description": "string",
  "appointment_location": "string",
  "appointment_owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "appointment_subject": "string",
  "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "availability_tzid": "string",
  "buffer_time_after": 1,
  "buffer_time_before": 1,
  "confirmation_page_url": "string",
  "minimum_notice_time": 1,
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "planning_day_offset": 1,
  "planning_period_from": "2019-01-01",
  "planning_period_to": "2019-01-01",
  "reminder_email_offset": 1,
  "reply_company_email_id": "01234567-abcd-dcba-ffff-000000000000",
  "schedule_name": "string",
  "time_increment": 1,
  "url": "string",
  "additional_fields_data": [
    {
      "field_id": "01234567-abcd-dcba-ffff-000000000000",
      "label": "string"
    }
  ],
  "appointment_invitees_data": [
    {
      "entity_id": "01234567-abcd-dcba-ffff-000000000000",
      "email": "string",
      "type": 1
    }
  ]
}

Response

Modification confirmation. Returns resulting AppointmentSchedule

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "appointment_description": "string",
    "appointment_location": "string",
    "appointment_owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "appointment_subject": "string",
    "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "availability_tzid": "string",
    "buffer_time_after": 1,
    "buffer_time_before": 1,
    "confirmation_page_url": "string",
    "minimum_notice_time": 1,
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "planning_day_offset": 1,
    "planning_period_from": "2019-01-01",
    "planning_period_to": "2019-01-01",
    "reminder_email_offset": 1,
    "reply_company_email_id": "01234567-abcd-dcba-ffff-000000000000",
    "schedule_name": "string",
    "time_increment": 1,
    "url": "string",
    "additional_fields_data": [
      {
        "field_id": "01234567-abcd-dcba-ffff-000000000000",
        "label": "string"
      }
    ],
    "appointment_invitees_data": [
      {
        "entity_id": "01234567-abcd-dcba-ffff-000000000000",
        "email": "string",
        "type": 1
      }
    ]
  }
}