Bulk delete series

delete

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

Bulk delete sermon series. The query filters are the same as for searching series and select the candidate set; the body picks the series within it. Provide ids, or explicitly set include to false to delete every series matching the filters (and every series outright when no filters are given); an empty body is rejected. Sermons in deleted series are kept; they just no longer belong to a series.

Required permission: Full Write Sermons

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include series whose name contains this text.

description

string

Include series whose description contains this text.

earliest.start

date-time

Include series whose first sermon is dated on or after this date and time (UTC).

earliest.end

date-time

Include series whose first sermon is dated on or before this date and time (UTC).

latest.start

date-time

Include series whose most recent sermon is dated on or after this date and time (UTC).

latest.end

date-time

Include series whose most recent sermon is dated on or before this date and time (UTC).

count.start

double

Include series with at least this many sermons.

count.end

double

Include series with at most this many sermons.

Body Params

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