Delete position requests

delete

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

Delete requests to fill the group's serving positions without notifying the requesters. Provide ids, or explicitly set include to false to delete every request matching the filters; an empty body is rejected.

Required permission: Limited Write Groups

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

group

int32

required

≥ 1

The id of the group the requests are in

Query Params

entry

int32

≥ 1

The id of a specific request to return.

position

string

Comma-delimited list of position ids. Values come from /api/groups/{id}/positions.

decision

string

Comma-delimited list of request decisions: pending (1), approved (2) or denied (3). Accepts the names or the numbers.

created.start

date-time

Return requests submitted on or after this date.

created.end

date-time

Return requests submitted on or before this date.

first

string

Return requests whose requester's first name contains the given text.

last

string

Return requests whose requester's last name contains the given text.

name

string

Text matched against the requester's names and aliases. When multiple words are given, every word must match.

string

Return requests whose requester's email address contains the given text.

phone

string

Return requests whose requester's phone number contains the given digits.

Body Params

The selection criteria for the requests

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!