Delete plans in bulk

delete

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

Delete several service plans. Provide ids, or explicitly set include to false to delete every plan matching the filters (and every plan 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

title

string

Include plans which contain this text in the title.

subtitle

string

Include plans which contain this text in the subtitle.

type

string

Comma-delimited list of service type ids or codes (e.g. plan_type_worship). Values come from /api/plans/servicetypes.

date.start

date-time

Include plans whose earliest date falls on or after this date and time.

date.end

date-time

Include plans whose earliest date falls on or before this date and time.

active

boolean

When true, include only plans with an upcoming time (or no times yet). When false, include only plans whose times have all passed.

public

boolean

Filter by whether the plan is shared publicly.

location

string

Comma-delimited list of location ids. Use -1 to include plans without a location.

Body Params

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