Delete rooms

delete

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

Delete several rooms at once. Provide ids, or explicitly set include to false to delete every room matching the filters (and every room outright when no filters are given); an empty body is rejected.

Required permission: Full Write Facilities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return rooms whose name contains the given text.

description

string

Return rooms whose description contains the given text.

location

string

Comma-delimited list of campus ids. Values come from /api/locations.

category

string

Comma-delimited list of room category ids. Values come from /api/property_values/room_categories/values.

occupancy.start

double

Return rooms that hold at least this many people.

occupancy.end

double

Return rooms that hold at most this many people.

active

boolean

Whether to return active or inactive rooms.

createdBy

string

Return rooms created by a user whose name contains the given text.

filter

string

Full-text search text. Matching rooms are returned ranked by relevance.

Body Params

The ids of the rooms to delete

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

401

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