---
title: "AppointmentSchedules.update"
method: PATCH
path: "/entities/AppointmentSchedules/{id}"
tags: ["Activity"]
---

# AppointmentSchedules.update

`PATCH /entities/AppointmentSchedules/{id}`

Modifies AppointmentSchedule or AppointmentSchedules with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateAppointmentScheduleInput
  - `appointment_description` string — Description applied to appointments booked through this schedule.
  - `appointment_duration` number, double — Duration of each booked appointment.
  - `appointment_location` string — Location applied to appointments booked through this schedule.
  - `appointment_location_type` 0 | 1 | 2 — How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting). Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom
  - `appointment_owner_id` string, uuid — Id of the user receiving the booking.
  - `appointment_subject` string — Subject applied to appointments booked through this schedule.
  - `appointment_subject_uses_schedule_name` boolean — When true, booked appointments use the schedule_name as their subject instead of appointment_subject.
  - `appointment_type_id` string, uuid — Id of the appointment type.
  - `availability_tzid` string — IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
  - `buffer_time_after` integer — Minutes of buffer reserved after each booked appointment.
  - `buffer_time_before` integer — Minutes of buffer reserved before each booked appointment.
  - `confirmation_page_type` 0 | 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_url` string — Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect.
  - `is_enabled` boolean — Master switch for the schedule. Disabled schedules do not accept new bookings.
  - `minimum_notice_time` integer — Minimum notice in hours required before a slot can be booked.
  - `name` string — Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name.
  - `owner_id` string, uuid — Id of the schedule owner.
  - `planning_day_offset` integer — For rolling planning: how many days ahead the schedule remains bookable.
  - `planning_period_from` string, date — For fixed-range planning: first date bookings are accepted for.
  - `planning_period_to` string, date — For fixed-range planning: last date bookings are accepted for.
  - `planning_type` 0 | 1 | 2 — How far ahead bookings are accepted (e.g. RollingDays, FixedRange). Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period
  - `reminder_email_enabled` boolean — True when a reminder email is sent to invitees ahead of the booked appointment.
  - `reminder_email_offset` integer — Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type.
  - `reminder_email_offset_type` 0 | 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_id` string, uuid — Id of the reply company email.
  - `schedule_name` string — Public-facing name of the schedule, shown to bookers on the booking page.
  - `time_increment` integer — Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45).
  - `type` 0 | 1 — Schedule type (e.g. one-on-one or round-robin). Integer enum value: 0 - OneToOne, 1 - Group
  - `url` string — Public URL slug of the schedule, used to share the booking page.
  - `additional_fields_data` object[] — Custom fields the booker is asked to fill in on the booking page, in display order.
    - `field_id` string, uuid, required — Field id
    - `label` string, required — Field label
    - `is_required` boolean, required — Whether value may be null/empty
  - `availability_data` object — Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone.
  - `appointment_invitees_data` object[] — Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses).
    - `entity_id` string, uuid — Entity id or null
    - `email` string, required — Email address
    - `type` 1 | 2 | 3, required — Integer enum value: 1 - Client, 2 - Contact, 3 - Email

## Response `200`

Modification confirmation. Returns resulting AppointmentSchedule

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` AppointmentSchedule
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `appointment_owner` string, uri, required — User assigned as the appointment owner when a booking is made through this schedule. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `appointment_type` string, uri, required — Appointment type used when a booking is created. Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' object for properties.
    - `owner` string, uri, required — Owner of the schedule (typically the team member whose availability is exposed). Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `reply_company_email` string, uri — Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' object for properties.
    - `appointment_description` string, required — Description applied to appointments booked through this schedule.
    - `appointment_duration` number, double — Duration of each booked appointment.
    - `appointment_location` string, required — Location applied to appointments booked through this schedule.
    - `appointment_location_type` 0 | 1 | 2 — How the location is interpreted (e.g. PhysicalAddress, OnlineMeeting). Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom
    - `appointment_owner_id` string, uuid, required — Id of the user receiving the booking.
    - `appointment_subject` string, required — Subject applied to appointments booked through this schedule.
    - `appointment_subject_uses_schedule_name` boolean, required — When true, booked appointments use the schedule_name as their subject instead of appointment_subject.
    - `appointment_type_id` string, uuid, required — Id of the appointment type.
    - `availability_tzid` string — IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined.
    - `buffer_time_after` integer, required — Minutes of buffer reserved after each booked appointment.
    - `buffer_time_before` integer, required — Minutes of buffer reserved before each booked appointment.
    - `confirmation_page_type` 0 | 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_url` string — Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect.
    - `is_enabled` boolean, required — Master switch for the schedule. Disabled schedules do not accept new bookings.
    - `minimum_notice_time` integer, required — Minimum notice in hours required before a slot can be booked.
    - `name` string, required — Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name.
    - `owner_id` string, uuid, required — Id of the schedule owner.
    - `planning_day_offset` integer, required — For rolling planning: how many days ahead the schedule remains bookable.
    - `planning_period_from` string, date — For fixed-range planning: first date bookings are accepted for.
    - `planning_period_to` string, date — For fixed-range planning: last date bookings are accepted for.
    - `planning_type` 0 | 1 | 2 — How far ahead bookings are accepted (e.g. RollingDays, FixedRange). Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period
    - `reminder_email_enabled` boolean, required — True when a reminder email is sent to invitees ahead of the booked appointment.
    - `reminder_email_offset` integer, required — Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type.
    - `reminder_email_offset_type` 0 | 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_id` string, uuid — Id of the reply company email.
    - `schedule_name` string, required — Public-facing name of the schedule, shown to bookers on the booking page.
    - `time_increment` integer, required — Step in minutes between offered start times (e.g. 15 means slots at :00, :15, :30, :45).
    - `type` 0 | 1 — Schedule type (e.g. one-on-one or round-robin). Integer enum value: 0 - OneToOne, 1 - Group
    - `url` string, required — Public URL slug of the schedule, used to share the booking page.
    - `additional_fields_data` object[], required — Custom fields the booker is asked to fill in on the booking page, in display order.
      - `field_id` string, uuid, required — Field id
      - `label` string, required — Field label
      - `is_required` boolean, required — Whether value may be null/empty
    - `availability_data` object, required — Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone.
    - `appointment_invitees_data` object[], required — Default invitees added to appointments booked through this schedule (Pipeliner users or external email addresses).
      - `entity_id` string, uuid — Entity id or null
      - `email` string, required — Email address
      - `type` 1 | 2 | 3, required — Integer enum value: 1 - Client, 2 - Contact, 3 - Email

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)