--- title: "deactivateCampaign" method: POST path: "/campaigns/{id}/deactivate" tags: ["Campaign"] --- # deactivateCampaign `POST /campaigns/{id}/deactivate` Deactivate a Campaign ## Path parameters - `id` integer, required ## Response `200` Success - Campaign - `address1` string, nullable — First line of address - `campaign_template_id` integer, nullable — Primary identifier of the Campaign Template this Campaign was created from - `studio_template_id` integer, nullable — Primary identifier of the Studio Template this Campaign was created from - `is_linked` boolean — 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_at` string, 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_at` string, 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_url` string, nullable — Canonical url of the Campaign - `category_id` integer, nullable — Category designation for Campaign - `channel_id` integer, nullable — Channel designation for Campaign - `channel_keywords` string, nullable — List of keywords Campaign is tagged with - `city` string, nullable — City name - `contact_email` string, nullable — Email address for the Campaign Contact. Set to the Organization Email by default if none is specified - `contact_phone` string — Phone number for the Campaign Contact - `country` string, nullable — Country name - `created_at` string, date-time — Date/time of initial record creation - `created_with` 'api' | 'classyapp' — Indicates which application created the Campaign - `currency_code` string — ISO code of the currency against which this Campaign is normalized. Inherited from Organization's currency code. - `default_page_appeal_email` string, nullable — Default appeal text displayed on Fundraising Pages - `default_page_goal` number, double — Default goal for the Campaign's Fundraising Pages. Presented in units of the Campaign's currency_code - `default_page_thank_you_email` string, nullable — Default thank you email text for the Campaign's Fundraising Pages - `default_team_appeal_email` string, nullable — Default appeal email text for Fundraising Teams - `default_team_goal` number, double — Default goal for the Campaign's Fundraising Teams. Presented in units of the Campaign's currency_code. - `default_team_thank_you_email` string, nullable — Default thank you email text for the Campaign's Fundraising Teams - `designation_id` integer, nullable — ID of Designation the Campaign Transactions will be allocated to - `display_group_name` boolean — Flag to determine if Designation Group Names should be shown - `ended_at` string, date-time, nullable — Date/time of when the campaign ends - `effective_fixed_fot_percent` string, 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_percent` number, 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_id` string, nullable — A unique identifier provided by an external system (e.g., Salesforce) that is associated with this campaign. - `external_url` string, 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 - `goal` number, double, nullable — Fundraising goal for this Campaign normalized against currency_code - `hide_from_profile` boolean, nullable — Indicates whether the Campaign will be hidden on the profile - `id` integer — Primary identifier of record - `internal_name` string, nullable — Internal name for Campaign. Can differ from name attribute - `is_fees_free` boolean, nullable — Indicates whether the Campaign has Fees associated with it or not - `is_general` number, nullable — Indicates whether the Campaign is general or not. Boolean returned as 0 or 1 accordingly. - `location_details` string — Additional information about the location of the event (e.g. directions, clarifications) - `minimum_donation_amount` number — Determines the minimum donation amount allowed. - `name` string — Campaign name - `organization_id` integer — Primary identifier for the associated Organization - `postal_code` string, nullable — Zip Code - `raw_currency_code` string — ISO code of the currency in which this Campaign should be presented. Defaults to `currency_code` value if not specified. - `raw_goal` string — Raw Fundraising Goal for this Campaign - `redirect_url` string, nullable — Redirect the unpublish campaign to this url - `sort_designation_by` 'A-Z' | 'NEW-OLD' | 'OLD-NEW' — How to sort within Designation Groups - `started_at` string, date-time — Date/time the campaign begins - `state` string, nullable — State/province name - `status` 'active' | 'deactivated' | 'draft' | 'unpublished' — Status of Campaign - `timezone_identifier` string — Timezone Identifier - `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_at` string, date-time — Date/time of last alteration - `venue` string, nullable — Free text representing a location - `add_registration_fee` boolean — Indicates whether a registration fee is added or not - `allow_duplicate_fundraisers` boolean — Indicates whether a Campaign allows a single User to own several Fundraising Pages - `allow_fundraising_pages` boolean — 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_fundraising` boolean — Specifies whether a Campaign allows for Team Fundraising - `default_page_appeal` string, nullable — Default appeal text displayed on Fundraising Pages - `default_page_post_asset_id` integer, nullable — Default Asset ID of page story post - `default_page_post_body` string, nullable — Default body of page story post - `default_page_post_title` string, nullable — Default title of page story post - `default_team_appeal` string, nullable — Default appeal text displayed on Fundraising Teams - `default_team_post_asset_id` integer, nullable — Default Asset ID of team story post - `default_team_post_body` string, nullable — Default body of team story post - `default_team_post_title` string, nullable — Default title of team story post - `default_thank_you_text` string, nullable — Default thank you text on the thank you page - `fixed_fot_percent` string, double, nullable — Percentage Campaign elects to be added to Fee on top (aka Classy Mode) Transactions to cover Fees - `flex_rate_percent` number, double, nullable — Percentage Campaign elects to be added to donor covered fees calculation to cover any additional costs other than fees. - `is_billing_address_required` boolean — If true, a billing address must be provided when creating Transactions against the Campaign - `is_ended_at_hidden` boolean — If true, Campaign end date is not shown - `is_started_at_hidden` boolean — If true, Campaign start date is not shown - `pages_can_set_appeal` boolean — Indicates whether Fundraising Pages can set the appeal - `pages_can_set_goal` boolean — 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_appeal` boolean — Indicates whether Fundraising Teams can set the appeal - `teams_can_set_goal` boolean — Indicates whether Fundraising Teams can set the goal - `ticket_pass_on_fees` boolean, nullable — Indicates whether a Campaign passes Fees from tickets to the user or not (fee on top for tickets) - `allow_ecards` boolean — Whether Ecard Dedications are available for this Campaign - `classy_mode_appeal` string, nullable — Classy mode appeal text - `classy_mode_checked_by_default` boolean — Whether or not classymode or dcf is checked by default on a donation page. Despite the name, also applies to DCF - `classy_mode_enabled` boolean, nullable — If true, give the donor the option to cover the Transaction Fee via ClassyMode calculation - `checkout_corporate_donation_enabled` boolean — If true, show the company credit card option on the ticketing checkout page - `corporate_donation_enabled` boolean — If true, give the donor the option to donate on the behalf of a corporation - `custom_url` string, nullable — Custom URL - `daf_enabled` boolean — If true, give the donor the ability to connect a donor advised fund (DAF) - `dcf_enabled` boolean — If true, give the donor the option to cover the Transaction Fee via Donor Covered Fees calculation - `dcf_allowed` boolean — 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_attribution` boolean, 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_donations` boolean — If true, Donation forms will not display the anonymous Donation field - `hide_recurring_end_date` boolean — Indicates whether the end date for recurring donations will be hidden in the donation page - `hide_contact_opt_in` boolean — If true, Donation forms will not display the contact opt in field - `hide_donation_amounts` boolean — If true, donors will not be able to hide their donation amounts - `hide_dedications` boolean — If true, donation dedications will not be offered - `hide_donation_comments` boolean — If true, donation forms will not display the donation comments field - `offer_dedication_postal_notifications` boolean — If true, offer to collect mailing information for postal notifications for dedications - `opt_in_checked_by_default` boolean — 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_url` string, nullable — Return URL - `send_dedication_emails` boolean, nullable — If true, send dedication email for donation - `logo_id` integer, nullable — Primary identifier of Asset used as the main Campaign Logo. Interpreted from associated Campaign Theme - `logo_url` string, nullable — URL for logo image. Either hardcoded URL for legacy Campaigns or interpreted from logo Asset specified by logo ID - `team_cover_photo_id` integer, 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_url` string, 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_modal` boolean — Indicates if Exit Modal is toggle on/off for a certain Campaign - `use_intelligent_ask_onetime` boolean, nullable — Toggle Intelligent Ask Amount for One-time donations - `use_intelligent_ask_recurring` boolean, nullable — Toggle Intelligent Ask Amount for Recurring donations - `whitelist_url` string, nullable — Used to bypass security blocking conditions in the donor iframe, based on X-FRAME-OPTIONS ALLOW-FROM ## Other responses - `400` — Campaign is already deactivated - `403` — Requester is not authorized to perform action - `404` — Campaign not found --- [API](https://skmtc.net/gofundme/apis/gofundme-pro-api.md) · [All operations](https://skmtc.net/gofundme/apis/gofundme-pro-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gofundme/gofundme-pro-api/versions/d22bb925eeed/schema)