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.
Donation campaign ID.
Revision number, which increments by 1 each time the donation campaign is updated. To prevent conflicting changes, the current revision must be passed when updating the donation campaign.
Ignored when creating a donation campaign.
Date and time the donation campaign was created.
Date and time the donation campaign was last updated.
Name of the donation campaign.
Whether the donation campaign is archived and hidden from site visitors. Archived campaigns cannot receive donations.
Default: false
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 falseCover image for the donation campaign.
Whether donors can specify their own donation amount. If custom amounts are disabled, at least one predefined amount must be provided.
Default: false
Settings for custom donation amounts.
Only relevant when customAmountEnabled is true.
List of predefined donation amounts presented to donors.
Each amount can include an optional description explaining its impact.
If this list is empty, customAmountEnabled must be true.
Campaign fundraising goal including target amount and completion settings.
Whether donors can add text comments to their donations.
Default: false
Donation frequencies available for this campaign.
At least one frequency must be specified.
Data Extensions
Tags assigned to this donation campaign.