Delete giving campaigns

delete

https://{tenant}.onechurchsoftware.com/api/pledges/campaigns

Delete many giving campaigns. Provide ids, or explicitly set include to false to delete every campaign matching the filters (and every campaign outright when no filters are given); an empty body is rejected.

Required permission: Full Write Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Text matched against the campaign's name.

description

string

Text matched against the campaign's description.

designation

string

Comma-delimited list of designation ids; returns campaigns that apply giving to any of them.

start.start

date-time

Return campaigns starting on or after this date.

start.end

date-time

Return campaigns starting on or before this date.

end.start

date-time

Return campaigns ending on or after this date.

end.end

date-time

Return campaigns ending on or before this date.

pledgesOnly

boolean

Whether only giving toward pledges counts for the campaign.

early

boolean

Whether the campaign allows giving before its start date.

active

boolean

Whether the campaign is currently active, i.e. its end date is in the future.

createdBy

string

Return campaigns created by the given user name (exact match).

pledges.start

double

Return campaigns with at least this many pledges.

pledges.end

double

Return campaigns with at most this many pledges.

goal.start

double

Return campaigns with a goal of at least this amount.

goal.end

double

Return campaigns with a goal of at most this amount.

pledged.start

double

Return campaigns with at least this amount pledged.

pledged.end

double

Return campaigns with at most this amount pledged.

paid.start

double

Return campaigns that raised at least this amount.

paid.end

double

Return campaigns that raised at most this amount.

remaining.start

double

Return campaigns with at least this amount remaining.

remaining.end

double

Return campaigns with at most this amount remaining.

percentage.start

double

Return campaigns at least this percent of the way to their goal (0-100).

percentage.end

double

Return campaigns at most this percent of the way to their goal (0-100).

Body Params

The selection criteria

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!