Delete positions

delete

https://{tenant}.onechurchsoftware.com/api/groups/positions

Delete serving positions along with their volunteer assignments, pending requests and linked form entries. Provide ids, or explicitly set include to false to delete every position matching the filters; an empty body is rejected.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

group

string

Comma-delimited list of group ids. Returns positions in those groups.

listed

boolean

Whether to return listed or unlisted positions.

name

string

Return positions whose name contains the given text.

description

string

Return positions whose description contains the given text.

active

boolean

Whether to return active or inactive positions.

enrollment

string

Comma-delimited list of enrollment method ids: 1 = anyone can sign up, 2 = approval required.

leader

string

Return positions whose supervisor's name, email or phone contains the given text.

form

int32

≥ 1

The id of a sign-up form. Returns positions using that form. Values come from /api/forms.

Body Params

Which positions 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.