Create room blockout date

post

https://{tenant}.onechurchsoftware.com/api/facilities/rooms/{room}/blockouts

Block out a date or date range when the room cannot be booked. Repeating blockouts can be created through schedules.

Required permission: Full Write Facilities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

room

int32

required

≥ 1

The id of the room

Body Params

The details of the blockout date

name

string | null

required

The name of the event.

start

date-time | null

required

When the event starts (UTC). When the event has time slots, this is the start of the earliest one.

end

date-time | null

When the event ends (UTC).

allDay

boolean | null

Whether the event runs all day rather than at specific times.

schedules

array of objects | null

The repeating schedule definitions for the event.

schedules

times

array of objects | null

The time slots for the event (UTC).

times

exceptions

object | null

For repeating events, dates added to or removed from the generated schedule (UTC).

action

string | null

For repeating events, which occurrences an edit applies to: all, future, or single. Defaults to only the event being edited.

changeSchedule

boolean | null

Set to true when an edit changes the repeating schedules; otherwise the existing recurrence is kept.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

404Not Found