Delete people

delete

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

Delete people in bulk. Provide ids to delete specific people, or set include to false to delete every person matching the query filters (and every person when no filters are given). Narrow the target set with the same parameters as the people search. For business profiles, deletion requires the Limited Write Contributions or Full Write Accounting permission instead of the one shown above.

Required permission: Full Write People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

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

archived

boolean

Whether to return archived (true) or active (false) profiles. If omitted, both are returned.

key.start

double

Return profiles whose id is greater than or equal to this value.

key.end

double

Return profiles whose id is less than or equal to this value.

first

string

Return profiles whose first name contains the given text.

last

string

Return profiles whose last name contains the given text.

letter

string

Return profiles whose last name starts with the given letter.

string

Return profiles whose email address (their own or their family's) contains the given text.

phone

string

Return profiles whose phone number (their own or their family's) contains the given digits.

envelope

int32

The envelope number assigned to the person. Use -1 to return profiles with no envelope number.

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.

type

string

Comma-delimited list of record type ids. Values come from /api/property_values/person_record_type/values.

gender

string

Comma-delimited list of gender ids. Values come from /api/property_values/gender/values.

language

string

Comma-delimited list of language ids. Values come from /api/property_values/languages/values.

ethnicity

string

Comma-delimited list of ethnicity ids. Values come from /api/property_values/ethnicities/values.

maritalStatus

string

Comma-delimited list of marital status ids. Values come from /api/property_values/marital_status/values.

position

string

Comma-delimited list of household role ids. Values come from /api/property_values/household_roles/values.

race

string

Comma-delimited list of race ids. Values come from /api/property_values/race/values.

occupation

string

Comma-delimited list of occupation ids. Values come from /api/property_values/occupations/values.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include profiles with no campus.

birthday.month

int32

Match dates falling in this month (1-12).

birthday.day

int32

Match dates falling on this day of the month (1-31).

birthday.year

int32

Match dates falling in this year.

birthday.start

date-time

Match dates falling within a window starting at this date.

birthday.end

date-time

Match dates falling within a window ending at this date.

anniversary.month

int32

Match dates falling in this month (1-12).

anniversary.day

int32

Match dates falling on this day of the month (1-31).

anniversary.year

int32

Match dates falling in this year.

anniversary.start

date-time

Match dates falling within a window starting at this date.

anniversary.end

date-time

Match dates falling within a window ending at this date.

age.start

double

Return people whose age is greater than or equal to this value.

age.end

double

Return people whose age is less than or equal to this value.

recurring

boolean

Whether the person has at least one active recurring giving schedule.

createdBy

string

Return profiles created by the given user name.

filter

string

Free text search across the profile's names, former names, email, phone and address.

Body Params

The deletion selection.

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.

family

boolean

When true, the same action cascades to the rest of the person's family members.

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!