Create facility request

Request rooms and items for an event. For a repeating event, one request is created per occurrence matching the booked dates; rooms and items on an auto-approve strategy are approved immediately, all others start pending. Send either start and end or the church-zone times startTime and endTime (HH:mm in the church's time zone, anchored on each booked occurrence's day); when start or end is present the times are ignored.

Required permission: Full Write Facilities

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the requests

event
object | null
required

The event the bookings are for. Only the id is used. For an occurrence of a repeating event, bookings are created on every occurrence matching the requested dates.

campus
object | null
required

The campus the bookings are at. Only the id is used.

string | null

Setup notes for the created request(s).

date-time | null

When the booking starts (UTC). The time of day is applied to each booked event day. Send either start and end or startTime and endTime; a request that carries an instant is read as instant-based and the time twins are ignored.

date-time | null

When the booking ends (UTC). The time of day is applied to each booked event day, or to the following day when it is earlier than the start time. Send either start and end or startTime and endTime; a request that carries an instant is read as instant-based and the time twins are ignored.

string | null

The wall-clock time each booking starts, in the church's time zone (HH:mm). Used when start and end are omitted.

string | null

The wall-clock time each booking ends, in the church's time zone (HH:mm). Used when start and end are omitted. A time earlier than startTime falls on the day after each booked event day.

rooms
array of objects | null

The rooms to book. Each room's availability date ranges select the occurrence day(s) it is booked on.

rooms
items
array of objects | null

The items to book. Each item's availability date ranges select the occurrence day(s) it is booked on.

items
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

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

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json