FUfundraiseup
Campaigns

Update a campaign

Changed on

This request allows you to update a campaign. Only the provided fields are updated; omitted fields keep their current values. A clearable field passed as null is cleared, and a list passed empty is emptied. Only base campaign types are supported.

post/v1/campaigns/{id}

Request

Path parameters

idstring required
Example:FUNXXXXXXXX

Unique identifier of the campaign, formatted as FUN[A-Z\d]{8}.

Request body

codestring nullable

Campaign code used for exports and integrations.

end_datestring nullable

Date the campaign is archived automatically, in ISO 8601 format.

formatsstring[]

Formats the campaign is enabled in. The list replaces the current formats: an empty list disables every format. Omit the field to leave the formats unchanged.

livemodeboolean

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Campaigns only exist in live mode — set this to true.

namestring

Campaign name.

url_pathstring nullable

Campaign URL path, unique within the account. Used in the Campaign Page URL.

Example request

{
  "code": "WINTER-26",
  "content": {
    "ar": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "da": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "de": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "en": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "es": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "fi": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "fr": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "he": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "hu": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "it": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "ja": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "ko": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "nl": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "no": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "pl": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "pt": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "ru": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "sv": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    },
    "zh": {
      "ask": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      },
      "campaign_page": {
        "links": [
          {
            "label": "About us",
            "url": "https://example.org/about"
          }
        ]
      }
    }
  },
  "end_date": "2027-12-31T00:00:00.000Z",
  "formats": [
    "checkout_modal"
  ],
  "frequencies": {
    "annual": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "bimonthly": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "biweekly": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "daily": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "every4weeks": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "monthly": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "once": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "quarterly": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "semiannual": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    },
    "weekly": {
      "default_amount": "5.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "25.00",
        "50.00",
        null,
        "100.00"
      ]
    }
  },
  "livemode": true,
  "name": "Winter Appeal",
  "settings": {
    "custom_fields": [
      {
        "name": "source",
        "value": "partner-portal"
      }
    ],
    "default_language": "en-US",
    "donation_matching": {
      "limit": "5.00",
      "minimum_amount": "5.00",
      "start_date": "2027-01-01T00:00:00.000Z"
    },
    "mailing_from_amount": "5.00",
    "mailing_required_from_amount": "5.00",
    "phone": {
      "enabled": true,
      "legal_text_enabled": true
    },
    "questions": [
      "QXXXXXXX"
    ],
    "supported_languages": [
      "en",
      "fr"
    ]
  },
  "url_path": "winter-appeal"
}

Response

On success, the API returns the updated campaign object with all settings.

campaign_page_urlstring nullable required

Public URL of the campaign page.

codestring nullable required

Campaign code, as set in the Dashboard.

contentobject required

Localized campaign content keyed by language code. Contains an entry for every supported language.

currency'shp' | 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'ang' | 'xcg' | 'awg' | 'azn' | 'bam' | 'bbd' | 'inr' | 'pkr' | 'bdt' | 'xof' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'myr' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'btn' | 'nok' | 'zar' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'xaf' | 'chf' | 'nzd' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'etb' | 'fjd' | 'fkp' | 'jpy' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'idr' | 'ils' | 'isk' | 'jmd' | 'jod' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'sek' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sgd' | 'sll' | 'sle' | 'sos' | 'srd' | 'std' | 'svc' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'zmw' | 'btc' | 'eth' | 'usdt' | 'usdc' | 'sol' | 'dot' | 'doge' | 'shib' | 'ltc' | 'bch' | 'xtz' | 'fil' | 'ftm' | 'gala' | 'paxg' | 'zec' required

Three-letter ISO currency code, in lowercase.

designation_mode'select' | 'assign' required

Designation selection mode.

end_datestring nullable required

Timestamp in ISO 8601 format, indicating when the campaign ends in UTC. null if no end date is set.

formatsstring[] required

Enabled campaign formats: checkout_modal and/or campaign_page.

idstring required

Unique campaign identifier.

namestring required

Campaign name.

status'active' | 'disabled' | 'auto_archive' | 'archived' required

Current status of the campaign: active — the campaign accepts donations, auto_archive — the campaign is active and will be archived automatically on end_date, disabled — the campaign is turned off, archived — the campaign is archived.

tagsstring[] required

Campaign tags, as set in the Dashboard.

type'regular' required

Type of the campaign.

url_pathstring nullable required

Custom URL path of the Campaign Page. null if the campaign identifier is used instead.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "campaign_page_url": "https://org.fundraiseup.com/page/FUNXXXXXXXX",
  "code": "Code-1",
  "currency": "usd",
  "designation_mode": "select",
  "designations": [
    {
      "code": "GEN-01",
      "frequencies": [
        "once",
        "monthly"
      ],
      "id": "EXXXXXXX",
      "is_default": true,
      "name": "General Fund",
      "type": "designation"
    }
  ],
  "end_date": "2026-12-31T00:00:00.000Z",
  "formats": [
    "checkout_modal",
    "campaign_page"
  ],
  "frequencies": [
    {
      "default": true,
      "default_amount": "60.00",
      "minimum_amount": "5.00",
      "suggested_amounts": [
        "1000.00",
        "500.00",
        "250.00",
        null,
        "50.00",
        "25.00"
      ],
      "type": "monthly"
    }
  ],
  "id": "FUNXXXXXXXX",
  "media": {
    "ask": {
      "image": {
        "height": 800,
        "url": "https://ucarecdn.com/5c0f2ed9-539d-4bf8-a338-0ec839cf74f2/",
        "width": 1200
      },
      "logo": {
        "height": 800,
        "url": "https://ucarecdn.com/5c0f2ed9-539d-4bf8-a338-0ec839cf74f2/",
        "width": 1200
      },
      "video": {
        "provider": "youtube",
        "url": "https://www.youtube.com/watch?v=abc"
      }
    },
    "campaign_page": {
      "image": {
        "height": 800,
        "url": "https://ucarecdn.com/5c0f2ed9-539d-4bf8-a338-0ec839cf74f2/",
        "width": 1200
      },
      "logo": {
        "height": 800,
        "url": "https://ucarecdn.com/5c0f2ed9-539d-4bf8-a338-0ec839cf74f2/",
        "width": 1200
      },
      "video": {
        "provider": "youtube",
        "url": "https://www.youtube.com/watch?v=abc"
      }
    }
  },
  "name": "My Campaign",
  "settings": {
    "ai_default_frequency": true,
    "anonymous_enabled": true,
    "ask_page_enabled": true,
    "campaign_page": {
      "sharing": {
        "copy_link": true,
        "facebook": true,
        "linkedin": true
      },
      "thank_you": {
        "sharing": {
          "facebook": true,
          "linkedin": true
        },
        "type": "thank_you_screen"
      }
    },
    "consent": {
      "customized": {
        "channels": {
          "email": true,
          "phone_calls": true,
          "social_media": true
        },
        "collection_method": "explicit_opt_in"
      },
      "general": {
        "show_if_required_by_law": true
      },
      "type": "customized"
    },
    "custom_fields": [
      {
        "name": "source",
        "value": "api"
      }
    ],
    "default_language": "en-US",
    "default_payment_type": "money",
    "disclaimer_enabled": true,
    "donation_matching": {
      "enabled": true,
      "end_date": "2026-12-31T00:00:00.000Z",
      "limit": "10000.00",
      "minimum_amount": "10.00",
      "ratio": "1:1",
      "sponsor_enabled": true,
      "sponsor_logo": {
        "height": 800,
        "url": "https://ucarecdn.com/5c0f2ed9-539d-4bf8-a338-0ec839cf74f2/",
        "width": 1200
      },
      "sponsor_name": "Sponsor Inc.",
      "start_date": "2026-01-01T00:00:00.000Z"
    },
    "mailing_enabled": true,
    "mailing_from_amount": "100.00",
    "mailing_required": true,
    "mailing_required_from_amount": "500.00",
    "money_enabled": true,
    "personalized_amounts": true,
    "phone": {
      "enabled": true,
      "legal_text_enabled": true
    },
    "post_donation_upsell": true,
    "pre_donation_upsell": true,
    "questions": [
      "QABCDEFG"
    ],
    "questions_enabled": true,
    "supported_languages": [
      "en",
      "fr"
    ],
    "terms_enabled": true,
    "thank_you": {
      "sharing": {
        "facebook": true,
        "linkedin": true
      },
      "type": "thank_you_screen"
    },
    "title_enabled": true,
    "transaction_costs": "smart_covering",
    "tribute": {
      "delivery_email": true,
      "highlight_name": true
    },
    "tribute_enabled": true
  },
  "status": "active",
  "tags": [
    "annual",
    "general"
  ],
  "type": "regular",
  "url_path": "winter-appeal"
}

Changes