Bulk delete service types

delete

https://{tenant}.onechurchsoftware.com/api/plans/servicetypes

Bulk delete service types, along with every plan and template of those types. Provide ids, or explicitly set include to false to delete every service type matching the filters (and every service type outright when no filters are given); an empty body is rejected.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include service types which contain this text in the name.

description

string

Include service types which contain this text in the description.

teams.start

double

Include service types with at least this many teams.

teams.end

double

Include service types with at most this many teams.

templates.start

double

Include service types with at least this many templates.

templates.end

double

Include service types with at most this many templates.

files.start

double

Include service types with at least this many attachments.

files.end

double

Include service types with at most this many attachments.

Body Params

The ids to delete, or the ids to exclude when include is false.

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.