Bulk delete songs

delete

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

Delete songs along with their arrangements, keys, and files. Provide ids, or explicitly set include to false to delete every song matching the filters (and every song outright when no filters are given); an empty body is rejected.

Required permission: Full Write Songs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

title

string

Include songs which contain this text in the title.

category

string

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

authors

string

Include songs which contain this text in the authors.

ccli

string

Include songs whose CCLI number contains this text.

arrangements.start

double

Include songs with at least this many arrangements.

arrangements.end

double

Include songs with at most this many arrangements.

filter

string

Free text search across the song title, CCLI number, category, notes, authors, and copyright.

Body Params

The songs 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.