Create item blockout date

post

https://{tenant}.onechurchsoftware.com/api/facilities/resources/{resource}/blockouts

Block out a date or date range when the item 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

resource

int32

required

≥ 1

The id of the item

Body Params

The details of the blockout date

name

string | null

required

The name of the event.

start

date-time | null

When the event starts, as a UTC instant. When the event has time slots, this is the start of the earliest one. On writes, an event that carries start or end is read as instant-based and startDate and endDate are ignored. On writes, required unless startDate is sent.

end

date-time | null

When the event ends, as a UTC instant. On writes, an event that carries start or end is read as instant-based and startDate and endDate are ignored.

startDate

date | null

The first calendar date of the event in the event's time zone (yyyy-MM-dd). On writes, used when the event is sent without UTC instants; an event that carries any instant is read as instant-based and this field is ignored. On writes, required unless start is sent.

endDate

date | null

The last calendar date of the event in the event's time zone (yyyy-MM-dd), inclusive. Equals startDate for a single-day event. On writes, used when the event is sent without UTC instants; an event that carries any instant is read as instant-based and this field is ignored.

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 event's time slots. Each carries UTC instants and wall-clock twins in the event's time zone.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

404Not Found