Create pledge

post

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

Record a new giving pledge for a person toward a giving campaign.

Required permission: Full Write Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the pledge

campaign

object | null

required

A reference to an existing record by its id.

person

object | null

required

A reference to an existing record by its id.

repetition

object | null

How the pledge's schedule ends. Provide the repetition code: "on" ends on the end date, "after" ends after the given number of occurrences.

amount

double

The amount pledged per interval.

household

boolean

Whether contributions from the whole household count toward the pledge.

frequency

object | null

How often the pledged amount is given. Provide the frequency id: 1 Weekly, 2 Bi-Weekly, 3 Semi-Monthly, 4 Monthly, 5 Quarterly, 6 Semi-Annually, 7 Annually, 8 One Time, 9 Bi-Monthly.

start

date-time | null

The date the pledge starts.

end

date-time | null

The date the pledge ends.

occurrences

int32 | null

The number of scheduled occurrences; meaningful when the pledge ends after a set number of occurrences. Defaults to 4 when omitted.

notes

string | null

Notes recorded on the pledge.

additional

double

The additional one-time amount pledged.

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