Delete sermons

delete

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

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

Required permission: Full Write Sermons

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include sermons which contain this text in the title.

summary

string

Include sermons which contain this text in the summary.

date.start

date-time

Include sermons published after this date and time (UTC).

date.end

date-time

Include sermons published before this date and time (UTC).

public

boolean

Whether the sermon is published online or not.

speaker

string

Comma-delimited list of speaker ids. Use -1 to include sermons without a speaker. Values come from /api/property_values/speakers/values.

series

string

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

tag

string

Comma-delimited list of tag ids. Values come from /api/property_values/sermon_tags/values.

book

string

Include sermons which cover the specified Bible book. Comma-delimited list of book ids. Use -1 to include sermons without any. Values come from /api/property_values/bible_books/values.

audio

boolean

Whether the sermon has an audio file uploaded.

video

boolean

Whether the sermon has a video.

transcript

boolean

Whether the sermon has a transcript entered.

except

string

Exclude specific sermons. Comma-delimited list of sermon ids to omit from the results.

featured

boolean

Filter by whether the sermon is featured.

filter

string

Free text search across the sermon title, summary, series, speaker, notes, and transcript.

Body Params

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

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!