Campaigns
Campaigns, also often referred to as fundraisers, are where donation activity occurs. There are several different types of campaigns, the differences of which can be found on our website.

The Campaign Object

Attribute
Description
id
The campaign ID.
type
The type of the campaign. Possible values: general, collect, fundraise, event.
title
The title of the campaign.
subtitle
The subtitle of the campaign.
description
The HTML content displayed as the description of the campaign.
slug
The slug to be used for this campaign. Must be unique across Givebutter.
goal
The campaign goal.
raised
The amount of money raised for this campaign.
donors
The number of donors who gave to this campaign.
end_at
A UTC datetime string indicating when the campaign ends.
url
The full URL of this campaign.
currency
The currency of this campaign (currently only USD is supported).
cover
An object representing the cover photo / banner of this campaign.
created_at
A UTC datetime string indicating when the campaign was created.
updated_at
A UTC datetime string indicating when the campaign was last updated.
meta
An object representing the meta tags of this campaign (includes title, description, and image).
account_id
The ID for the account that owns this campaign.
get
https://api.givebutter.com
/v1/campaigns/:id
Get Campaigns
This endpoint returns only campaigns created under your account by default. If your account has campaigns of which you are the beneficiary, or campaigns owned by chapter accounts, you'll need to change the scope parameter to the appropriate value.
post
https://api.givebutter.com
/v1/campaigns
Create a Campaign
Please ensure you are selecting the correct campaign type, as this effects the pricing tier of the campaign. See our website for more details.
patch
https://api.givebutter.com
/v1/campaigns/:id
Update a Campaign
delete
https://api.givebutter.com
/v1/campaigns/:id
Delete a Campaign
You can not delete campaigns that have already raised money, doing so will result in an error. If you need to delete a campaign that has already raised money, please contact us.
Last modified 1mo ago