COcoevera
Activity

AppointmentSchedules.batch_create_or_update

Creates or updates AppointmentSchedule records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/AppointmentSchedules/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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

Where booked appointments take place: the location given in appointment_location (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting.

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 used for appointments booked through the schedule.

availability_tzidstring

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

buffer_time_afterinteger

Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes).

buffer_time_beforeinteger

Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes).

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 seconds required before a slot can be booked (e.g. 3600 = one hour).

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

With Offset planning, how many days ahead the schedule remains bookable.

planning_period_fromstring date

With Period planning, first date bookings are accepted for.

planning_period_tostring date

With Period planning, last date bookings are accepted for.

planning_type0 | 1 | 2

Time window in which the schedule accepts bookings: any future date (Infinite), up to planning_day_offset days ahead (Offset), or between planning_period_from and planning_period_to (Period).

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

Time unit of reminder_email_offset: Minute, Hour, Day or Week.

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

reply_company_email_idstring uuid

Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default.

schedule_namestring

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

time_incrementinteger

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

type0 | 1

Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings.

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.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.