Update giving campaign

put

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

Update an existing giving campaign. This is a full update: every field is taken from the body, so optional fields that are omitted are cleared. First retrieve the current campaign from /api/pledges/campaigns/{id}, apply your changes, then send back the full object.

Required permission: Full Write Pledges

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the campaign

Body Params

The details for the new version

name

string | null

required

The campaign's name.

start

date-time | null

required

The date the campaign starts.

end

date-time | null

required

The date the campaign ends.

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-time | null

The date early giving may begin, when giving before the campaign start is allowed.

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

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! Or choose an example:

text/plain

application/json

text/json

404Not Found