Create giving campaign

post

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

Create a new giving campaign (a fundraiser where donors pledge toward a goal amount).

Required permission: Full Write Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the campaign

name

string | null

required

The campaign's name.

start

date | null

required

The calendar day the campaign starts (yyyy-MM-dd), in the church's calendar; no time component.

end

date | null

required

The calendar day the campaign ends (yyyy-MM-dd), inclusive: gifts on this day still count.

funds

array of objects | null

required

The designations giving to the campaign is applied to; at least one is required. On read each includes its per-designation giving totals; on write, provide only each designation's id. Populated only when the caller has the Full Read Pledges permission.

funds*

description

string | null

The campaign's description.

pledgesOnly

boolean | null

Whether only giving toward pledges counts for the campaign; otherwise all giving to its designations counts. Populated only when the caller has the Full Read Pledges permission.

early

boolean | null

Whether the campaign allows giving before its start date.

threshold

date | null

The earliest calendar day (yyyy-MM-dd) a gift counts toward the campaign when early giving is allowed; must not be after start. Null means any earlier gift counts.

amount

double | null

The campaign's goal amount; null when no goal is set. Must be greater than 0 when provided.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK

404Not Found