A donation campaign represents a fundraising initiative that allows collecting donations for a specific cause or goal. Campaigns can be configured with various donation options, including one-time and recurring payments, predefined amounts, and campaign goals.
Use the Donation Campaigns API to create and manage donation campaigns on your site.
Whether the donation campaign is archived and hidden from site visitors. Archived campaigns can't accept donations.
Default: false
Campaign fundraising goal.
Whether donors can add comments to their donations.
Default: false
Cover image for the donation campaign.
Date and time the donation campaign was created.
Whether donors can specify their own donation amount. If custom amounts are disabled, at least one predefined amount must be provided.
Default: false
Optional settings for custom donation amounts.
Donation frequencies available for this campaign.
At least one frequency must be specified.
Custom field data for the program definition object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Donation campaign ID.
Name of the donation campaign.
Predefined donation amounts.
Each amount can include an optional description explaining its impact. For example, "Feed 5 families for a week".
Revision number, which increments by 1 each time the donation campaign is updated.
To prevent conflicting changes, the current revision must be specified when updating the donation campaign.
Ignored when creating a donation campaign.
Current status of the donation campaign.
The status is automatically calculated based on campaign settings and current progress:
COLLECTING: Campaign is active and accepting donationsEXPIRED: Campaign has passed its end date and acceptDonationsAfterEndDate is falseGOAL_REACHED: Campaign has reached its target amount and acceptDonationsAfterGoal is falseTags assigned to this donation campaign.
Date and time the donation campaign was last updated.