Update facility request

put

https://{tenant}.onechurchsoftware.com/api/facilities/requests/{id}

Full update: rooms and items omitted from the body are removed from the request. First retrieve the current request from /api/facilities/requests/{id}, apply your changes, then send back the full object. Changing the request's times resets every line to pending. With the Full Write Facilities permission you can edit any request; otherwise only the associated event's organizer can.

Required permission: Full Write Facilities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the request

Body Params

The details of the request

start

date-time | null

required

When the requested booking starts (UTC). For a single-day event, the time of day is applied to the event's day.

end

date-time | null

required

When the requested booking ends (UTC). For a single-day event, the time of day is applied to the event's day.

campus

object | null

The campus the booking is at. Only the id is used on writes.

event

object | null

The event the booking is for. Only the id is used on writes; an edit keeps the request's existing event.

notes

string | null

The request's setup notes.

rooms

array of objects | null

The rooms requested. At least one room or item is required. Omitted lines are removed from the request on edit.

rooms

items

array of objects | null

The items requested. At least one room or item is required. Omitted lines are removed from the request on edit.

items

action

string | null

For a request on a repeating event, also apply the edit to all other requests in the series, or only future ones. Omit to update just this request.

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