Delete locations

delete

https://{tenant}.onechurchsoftware.com/api/locations

Bulk delete locations. The query filters are the same as for searching locations and select the candidate set; the body picks the locations within it. Provide ids, or explicitly set include to false to delete every location matching the filters (and every location outright when no filters are given); an empty body is rejected.

Required permission: Locations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Returns locations where the name contains the given search terms.

description

string

Returns locations where the description contains the given text.

type

string

Comma-delimited list of type ids. Use -1 to include locations without a type. Values come from /api/property_values/location_types/values.

active

boolean

Whether the location is active or not. If not provided, returns locations regardless of status.

Body Params

The ids of the locations 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.