Delete designations

delete

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

Bulk delete designations. Designations that have received gifts cannot be deleted; deactivate them instead. The query filters are the same as for searching designations and select the candidate set; the body picks the designations within it. Provide ids, or explicitly set include to false to delete every designation matching the filters (and every designation outright when no filters are given); an empty body is rejected.

Required permission: Contributions Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Include designations which contain this text in the name.

code

string

Include designations which contain this text in the abbreviation.

description

string

Include designations which contain this text in the description.

category

string

Comma-delimited list of category ids. Use -1 to include designations without a category. Values come from /api/property_values/fund_category/values.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include designations with no campus. Values come from /api/locations.

funds

string

Comma-delimited list of designation ids to restrict the results to.

portal

string

Comma-delimited list of giving portal ids. Use -1 to include designations not available on any giving portal.

deductible

boolean

Whether contributions to the designation are tax deductible or not.

active

boolean

Whether the designation is active or not. When filtering for inactive designations, also set all to true.

keywordsOnly

boolean

Only include designations with text-giving keywords. Giving statistics reflect text giving only.

amount.start

double

Only include designations whose total giving is at least this amount.

amount.end

double

Only include designations whose total giving is at most this amount.

transactions.start

double

Only include designations with at least this many transactions.

transactions.end

double

Only include designations with at most this many transactions.

schedules.start

double

Only include designations with at least this many recurring giving schedules.

schedules.end

double

Only include designations with at most this many recurring giving schedules.

latest.start

date-time

Only include designations that last received a gift on or after this date.

latest.end

date-time

Only include designations that last received a gift on or before this date.

filter

string

Free text search across the designation's name, abbreviation, category, and description.

Body Params

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

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!