Delete workflow people

delete

https://{tenant}.onechurchsoftware.com/api/workflows/people

Bulk remove entries (people going through workflows) from their workflows, without recording completed visits; any open assignments are deleted with them. The query filters select the candidate entries; the body picks the entries within that set. Provide ids, or explicitly set include to false to delete every entry matching the filters; an empty body is rejected. Requires the Workflows full-write permission, unless the filters are scoped to a single workflow the caller manages.

Required permission: Full Write Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

workflow

int32

≥ 1

The id of a workflow; returns only entries in that workflow.

person

int32

≥ 1

The id of a person; returns only that person's entries.

task

string

Comma-delimited list of workflow task ids. Task ids come from /api/workflows/{workflow}/tasks/list.

status

string

Comma-delimited list of status ids: 0 = Processing, 1 = Queued, 2 = Waiting, 3 = Past Due, 4 = Not Started, 5 = In Progress, 6 = Done, 7 = Reassign, 8 = Unable to Complete, 9 = Incomplete.

assignee

int32

≥ 1

The id of the person the related assignment is assigned to.

name

string

Text matched against the person's first, middle, last and former names plus aliases. When multiple words are given, every word must match.

string

Return entries for people whose email (or whose family's email) contains the given text.

phone

string

Return entries for people whose phone number (or whose family's phone number) contains the given digits.

address.street

string

The street address.

address.city

string

The city.

address.state

string

The state or province.

address.postalCode

string

The postal code.

address.country

string

The country.

recordType

string

Comma-delimited list of record type ids. Use -1 to include people with no record type.

campus

string

Comma-delimited list of campus ids. Use -1 to include people with no campus.

workflowName

string

Return entries whose workflow name contains the given text.

added.start

date-time

Return entries added on or after this date/time.

added.end

date-time

Return entries added on or before this date/time.

Body Params

The ids of the entries 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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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! Or choose an example:

text/plain

application/json

text/json

400Bad Request