campaign_template_idinteger nullable
Primary identifier of the Campaign Template this Campaign was created from
studio_template_idinteger nullable
Primary identifier of the Studio Template this Campaign was created from
is_linkedboolean
Whether the Campaign is currently consuming Studio Template updates. Defaults to false; set true when the campaign is created linked to a Studio Template, and false again on unlink.
linked_atstring date-time nullable
Set once when the campaign first becomes linked to a Studio Template at creation; never updated thereafter (no re-link path). NULL if never linked.
unlinked_atstring date-time nullable
Timestamp of the unlink operation. NULL until the campaign is unlinked from its Studio Template; written only by the unlink flow, never at creation. Never cleared.
canonical_urlstring nullable
Canonical url of the Campaign
category_idinteger nullable
Category designation for Campaign
channel_idinteger nullable
Channel designation for Campaign
channel_keywordsstring nullable
List of keywords Campaign is tagged with
contact_emailstring nullable
Email address for the Campaign Contact. Set to the Organization Email by default if none is specified
contact_phonestring
Phone number for the Campaign Contact
created_atstring date-time
Date/time of initial record creation
created_with'api' | 'classyapp'
Indicates which application created the Campaign
currency_codestring
ISO code of the currency against which this Campaign is normalized. Inherited from Organization's currency code.
default_page_appeal_emailstring nullable
Default appeal text displayed on Fundraising Pages
default_page_goalnumber double
Default goal for the Campaign's Fundraising Pages. Presented in units of the Campaign's currency_code
default_page_thank_you_emailstring nullable
Default thank you email text for the Campaign's Fundraising Pages
default_team_appeal_emailstring nullable
Default appeal email text for Fundraising Teams
default_team_goalnumber double
Default goal for the Campaign's Fundraising Teams. Presented in units of the Campaign's currency_code.
default_team_thank_you_emailstring nullable
Default thank you email text for the Campaign's Fundraising Teams
designation_idinteger nullable
ID of Designation the Campaign Transactions will be allocated to
display_group_nameboolean
Flag to determine if Designation Group Names should be shown
ended_atstring date-time nullable
Date/time of when the campaign ends
effective_fixed_fot_percentstring double nullable
Percentage to be added to fee on top (aka Classy Mode) Transactions for the Campaign to cover fees. If fixed fot percent is null falls back on the Organization's fixed fot percent
effective_flex_rate_percentnumber double nullable
Percentage Campaign elects to be added to donor covered fees calculation to cover any additional costs other than fees. If flex rate percent is null falls back on the Organization's flex rate percent
effective_recaptcha_settings'ENABLED' | 'DISABLED'
Indicates whether or not captcha should be displayed on checkout pages. If false at Org level, will not display on campaigns.
external_idstring nullable
A unique identifier provided by an external system (e.g., Salesforce) that is associated with this campaign.
external_urlstring nullable
When set on a Campaign, GoFundMe Pro will push all requests for this Campaign to the specified URL via HTTP redirect. Commonly used to redirect traffic from ended Campaign to another Site/Campaign
goalnumber double nullable
Fundraising goal for this Campaign normalized against currency_code
hide_from_profileboolean nullable
Indicates whether the Campaign will be hidden on the profile
idinteger
Primary identifier of record
internal_namestring nullable
Internal name for Campaign. Can differ from name attribute
is_fees_freeboolean nullable
Indicates whether the Campaign has Fees associated with it or not
is_generalnumber nullable
Indicates whether the Campaign is general or not. Boolean returned as 0 or 1 accordingly.
location_detailsstring
Additional information about the location of the event (e.g. directions, clarifications)
minimum_donation_amountnumber
Determines the minimum donation amount allowed.
organization_idinteger
Primary identifier for the associated Organization
postal_codestring nullable
raw_currency_codestring
ISO code of the currency in which this Campaign should be presented. Defaults to currency_code value if not specified.
raw_goalstring
Raw Fundraising Goal for this Campaign
redirect_urlstring nullable
Redirect the unpublish campaign to this url
sort_designation_by'A-Z' | 'NEW-OLD' | 'OLD-NEW'
How to sort within Designation Groups
started_atstring date-time
Date/time the campaign begins
status'active' | 'deactivated' | 'draft' | 'unpublished'
timezone_identifierstring
type'ticketed' | 'registration' | 'fund_for_entry' | 'peer_to_peer' | 'donation' | 'reg_w_fund' | 'crowdfunding' | 'dynamic' | 'gfm_npo' | 'gfm_p2p'
The campaign's type, which determines its functionality and features:
- donation: Classic standard donation page (retired)
- crowdfunding: Classic Crowdfunding campaign (retired)
- peer_to_peer: Classic Peer-to-Peer campaign
- ticketed: Ticketed Event campaign
- reg_w_fund: Registration with Fundraising campaign
- dynamic: Campaign Studio Donation Page and Embedded Form campaigns
- gfm_npo: Campaign used to process transactions from an organization's GoFundMe Nonprofit Page and individual fundraisers on behalf of the organization (only available if the organization's GoFundMe Nonprofit Page is claimed)
- gfm_p2p: GoFundMe Peer-to-Peer campaign that leverages GoFundMe for the fundraising experience (only available if the organization's GoFundMe Nonprofit Page is claimed)
updated_atstring date-time
Date/time of last alteration
venuestring nullable
Free text representing a location
add_registration_feeboolean
Indicates whether a registration fee is added or not
allow_duplicate_fundraisersboolean
Indicates whether a Campaign allows a single User to own several Fundraising Pages
allow_fundraising_pagesboolean
Specifies whether a Campaign allows for the creation of new Fundraising Pages. Only relevant for Campaigns with types that allow for Fundraising Pages in general
allow_team_fundraisingboolean
Specifies whether a Campaign allows for Team Fundraising
default_page_appealstring nullable
Default appeal text displayed on Fundraising Pages
default_page_post_asset_idinteger nullable
Default Asset ID of page story post
default_page_post_bodystring nullable
Default body of page story post
default_page_post_titlestring nullable
Default title of page story post
default_team_appealstring nullable
Default appeal text displayed on Fundraising Teams
default_team_post_asset_idinteger nullable
Default Asset ID of team story post
default_team_post_bodystring nullable
Default body of team story post
default_team_post_titlestring nullable
Default title of team story post
default_thank_you_textstring nullable
Default thank you text on the thank you page
fixed_fot_percentstring double nullable
Percentage Campaign elects to be added to Fee on top (aka Classy Mode) Transactions to cover Fees
flex_rate_percentnumber double nullable
Percentage Campaign elects to be added to donor covered fees calculation to cover any additional costs other than fees.
is_billing_address_requiredboolean
If true, a billing address must be provided when creating Transactions against the Campaign
is_ended_at_hiddenboolean
If true, Campaign end date is not shown
is_started_at_hiddenboolean
If true, Campaign start date is not shown
pages_can_set_appealboolean
Indicates whether Fundraising Pages can set the appeal
pages_can_set_goalboolean
Indicates whether Fundraising Pages can set the goal
team_membership_policy'optional' | 'required' | 'prohibited'
Configuration indicating whether team membership for this Campaign's Fundraising Pages is optional, required, or prohibited
teams_can_set_appealboolean
Indicates whether Fundraising Teams can set the appeal
teams_can_set_goalboolean
Indicates whether Fundraising Teams can set the goal
ticket_pass_on_feesboolean nullable
Indicates whether a Campaign passes Fees from tickets to the user or not (fee on top for tickets)
allow_ecardsboolean
Whether Ecard Dedications are available for this Campaign
classy_mode_appealstring nullable
classy_mode_checked_by_defaultboolean
Whether or not classymode or dcf is checked by default on a donation page. Despite the name, also applies to DCF
classy_mode_enabledboolean nullable
If true, give the donor the option to cover the Transaction Fee via ClassyMode calculation
checkout_corporate_donation_enabledboolean
If true, show the company credit card option on the ticketing checkout page
corporate_donation_enabledboolean
If true, give the donor the option to donate on the behalf of a corporation
custom_urlstring nullable
daf_enabledboolean
If true, give the donor the ability to connect a donor advised fund (DAF)
dcf_enabledboolean
If true, give the donor the option to cover the Transaction Fee via Donor Covered Fees calculation
dcf_allowedboolean
Whether or not the campaign will use DCF or classymode. If true, this means the campaign must be treated as a dcf campaign. All newly created campaigns should have dcf_allowed = true. For whether or not dcf should show up on a donation page, please see dcf_enabled.
disable_donation_attributionboolean nullable
Flag to allow/disallow donors to select a Fundraising Page or Team to attribute their Donation to. If true, Donation Attribution is disabled. Set to false to enable Donation Attribution
hide_anonymous_donationsboolean
If true, Donation forms will not display the anonymous Donation field
hide_recurring_end_dateboolean
Indicates whether the end date for recurring donations will be hidden in the donation page
hide_contact_opt_inboolean
If true, Donation forms will not display the contact opt in field
hide_donation_amountsboolean
If true, donors will not be able to hide their donation amounts
hide_dedicationsboolean
If true, donation dedications will not be offered
hide_donation_commentsboolean
If true, donation forms will not display the donation comments field
offer_dedication_postal_notificationsboolean
If true, offer to collect mailing information for postal notifications for dedications
opt_in_checked_by_defaultboolean
If true, and if the hide_contact_opt_in option is false, this will check the opt-in selection by default on donation forms
return_urlstring nullable
send_dedication_emailsboolean nullable
If true, send dedication email for donation
logo_idinteger nullable
Primary identifier of Asset used as the main Campaign Logo. Interpreted from associated Campaign Theme
logo_urlstring nullable
URL for logo image. Either hardcoded URL for legacy Campaigns or interpreted from logo Asset specified by logo ID
team_cover_photo_idinteger nullable
ID of the associated Asset that serves as the default cover photo for this Campaign's Teams (inherited from associated Theme)
team_cover_photo_urlstring nullable
URL for Campaign's default team cover photo image. Interpreted from team cover photo Asset specified by team cover photo ID
crypto_giving'enabled' | 'disabled' | 'exclusive'
Indicates if Crypto Giving is Enabled, Disabled or Exclusive
embedded_giving'disabled' | 'modal' | 'inline'
Indicates if Embedded Giving is Disabled, Modal or Inline
exit_modalboolean
Indicates if Exit Modal is toggle on/off for a certain Campaign
use_intelligent_ask_onetimeboolean nullable
Toggle Intelligent Ask Amount for One-time donations
use_intelligent_ask_recurringboolean nullable
Toggle Intelligent Ask Amount for Recurring donations
whitelist_urlstring nullable
Used to bypass security blocking conditions in the donor iframe, based on X-FRAME-OPTIONS ALLOW-FROM
fundraising_tracking_codestring nullable
Only in PUT call, to be added if org has tag early-access:fundraising-tracking-code