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).
logo
URL to the logo for the campaign.
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
Get Campaigns
https://api.givebutter.com/v1/campaigns/:id
Retrieve a list of your campaigns. Include an id to retrieve a specific campaign.
Request
Response
Request
Path Parameters
id
optional
string
ID of the campaign to get.
Query Parameters
scope
optional
string
The scope of campaigns to retrieve: 
null to retrieve only your account's campaigns.
benefiting to retrieve campaigns of which you are the beneficiary.
chapters to retrieve campaigns owned by chapters under your account.
all to retrieve all campaigns related to your account.
Response
200: OK
Campaign successfully retrieved.
{
    "id": 123,
    "account_id": "tFojY6OML6xZF521",
    "type": "collect",
    "title": "Giving Tuesday Fundraising Campaign",
    "subtitle": null,
    "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>",
    "slug": "74XqKK",
    "url": "https://givebutter.com/example",
    "goal": 10000,
    "raised": 4013,
    "donors": 591,
    "currency": "USD",
    "logo": "https://givebutter.com/...",
    "cover": {
        "type": "image",
        "url": "https://givebutter.com/...",
        "source": "upload"
    },
    "end_at": null,
    "created_at": "2020-05-05 04:26:31",
    "updated_at": "2020-05-15 16:57:47"
}
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
Create a Campaign
https://api.givebutter.com/v1/campaigns
Request
Response
Request
Body Parameters
description
optional
string
An HTML formatted description for the campaign. 
end_at
optional
string
A UTC formatted datetime string for the end date and time of the campaign. Ex: 2019-01-01 20:30:00
goal
optional
integer
A goal for the campaign.
subtitle
optional
string
A subtitle for the campaign.
slug
optional
string
The URL slug to be used for this campaign. If none is provided, we will generate one automatically. 
title
required
string
The title of the campaign.
type
required
string
Type type of campaign to be created. Supported options are: collect, fundraise, event.
Response
200: OK
{
    "id": 123,
    "account_id": "tFojY6OML6xZF521",
    "type": "collect",
    "title": "Giving Tuesday Fundraising Campaign",
    "subtitle": null,
    "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>",
    "slug": "74XqKK",
    "url": "https://givebutter.com/example",
    "goal": 10000,
    "raised": 4013,
    "donors": 591,
    "currency": "USD",
    "logo": "https://givebutter.com/...",
    "cover": {
        "type": "image",
        "url": "https://givebutter.com/...",
        "source": "upload"
    },
    "end_at": null,
    "created_at": "2020-05-05 04:26:31",
    "updated_at": "2020-05-15 16:57:47"
}
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
Update a Campaign
https://api.givebutter.com/v1/campaigns/:id
All parameters available in the Create a Campaign endpoint can be updated.
Request
Response
Request
Path Parameters
id
required
string
The ID of the campaign to update.
Response
200: OK
{
    "id": 123,
    "account_id": "tFojY6OML6xZF521",
    "type": "collect",
    "title": "Giving Tuesday Fundraising Campaign",
    "subtitle": null,
    "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>",
    "slug": "74XqKK",
    "url": "https://givebutter.com/example",
    "goal": 10000,
    "raised": 4013,
    "donors": 591,
    "currency": "USD",
    "logo": "https://givebutter.com/...",
    "cover": {
        "type": "image",
        "url": "https://givebutter.com/...",
        "source": "upload"
    },
    "end_at": null,
    "created_at": "2020-05-05 04:26:31",
    "updated_at": "2020-05-15 16:57:47"
}
delete
Delete a Campaign
https://api.givebutter.com/v1/campaigns/:id
Request
Response
Request
Path Parameters
id
required
string
The ID of the campaign to delete.
Response
200: OK
​
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.

Authentication

Members

Last updated 11 months ago

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).
logo	URL to the logo for the campaign.
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.

Campaigns

The Campaign Object

getGet Campaigns

postCreate a Campaign

patchUpdate a Campaign

deleteDelete a Campaign

get
Get Campaigns

post
Create a Campaign

patch
Update a Campaign

delete
Delete a Campaign