---
title: "update campaign"
method: PATCH
path: "/campaigns/{campaign}"
tags: ["Campaigns"]
---

# update campaign

`PATCH /campaigns/{campaign}`

Updates the campaign with the new data
#### For custom components:
`RaiselyComponents.api.one('campaigns', '{campaign}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>`

 :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Path parameters

- `campaign` string, required

## Query parameters

- `private` boolean

## Headers

- `Authorization` string

## Request body

- object
  - `data` UpdateCampaign
    - `allowExperiments` boolean — Allows the campaign to participate in Raisely experiments Examples: `true`, `false`
    - `currency` string — 3 letter currency code Examples: `AUD`, `USD`
    - `defaultDesignation` string — Designation that is assigned as the default designation for the campaign
    - `goal` integer — (in cents) Example: `500050`
    - `mode` 'LIVE' | 'TEST' — Mode for payment processing. Make sure to set this to LIVE before launching your campaign so you can take real donations. Examples: `LIVE`, `TEST`
    - `name` string — Name of the campaign Example: `<< campaign name >>`
    - `path` string — The path of this record (for alternative lookup) Example: `run-for-a-cure`
    - `primaryDomain` string — Primary domain of the campaign
    - `private` object — Private values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `public` object — Public values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `publicKey` string — (Internal Raisely field - ignored) Example: `aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`
    - `theme` string — The theme name by this campaign Examples: `donation-basic`, `donation-modern`, `donation-elegant`, `donation-expansive`, `donation-impact`, `donation-elegant`, `donation-active`, `peerToPeer-basic`, `peerToPeer-modern`, `peerToPeer-elegant`, `peerToPeer-expansive`, `peerToPeer-impact`, `peerToPeer-elegant`, `peerToPeer-active`, `appealsHub-basic`, `appealsHub-modern`, `appealsHub-elegant`, `appealsHub-expansive`, `appealsHub-impact`, `appealsHub-elegant`, `appealsHub-active`, `communityHub-basic`, `communityHub-modern`, `communityHub-elegant`, `communityHub-expansive`, `communityHub-impact`, `communityHub-elegant`, `communityHub-active`, `appeal-basic`, `appeal-modern`, `appeal-elegant`, `appeal-expansive`, `appeal-impact`, `appeal-elegant`, `appeal-active`, `special-virtualEvent`, `special-virtualAppeal`, `special-charityChallenge`
    - `urls` unknown[] — Custom domains of the campaign Example: `[ "yourdomain.com" ]`
      - unknown
    - `version` string — Theme version Example: `3.0.0`
  - `overwriteCustomFields` boolean — If passed, replace the existing `public` and `private` values on the record with the values provided with this payload

## Response `200`

The campaign record after update

- object
  - `data` UpdateCampaign
    - `allowExperiments` boolean — Allows the campaign to participate in Raisely experiments Examples: `true`, `false`
    - `currency` string — 3 letter currency code Examples: `AUD`, `USD`
    - `defaultDesignation` string — Designation that is assigned as the default designation for the campaign
    - `goal` integer — (in cents) Example: `500050`
    - `mode` 'LIVE' | 'TEST' — Mode for payment processing. Make sure to set this to LIVE before launching your campaign so you can take real donations. Examples: `LIVE`, `TEST`
    - `name` string — Name of the campaign Example: `<< campaign name >>`
    - `path` string — The path of this record (for alternative lookup) Example: `run-for-a-cure`
    - `primaryDomain` string — Primary domain of the campaign
    - `private` object — Private values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `public` object — Public values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
    - `publicKey` string — (Internal Raisely field - ignored) Example: `aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa`
    - `theme` string — The theme name by this campaign Examples: `donation-basic`, `donation-modern`, `donation-elegant`, `donation-expansive`, `donation-impact`, `donation-elegant`, `donation-active`, `peerToPeer-basic`, `peerToPeer-modern`, `peerToPeer-elegant`, `peerToPeer-expansive`, `peerToPeer-impact`, `peerToPeer-elegant`, `peerToPeer-active`, `appealsHub-basic`, `appealsHub-modern`, `appealsHub-elegant`, `appealsHub-expansive`, `appealsHub-impact`, `appealsHub-elegant`, `appealsHub-active`, `communityHub-basic`, `communityHub-modern`, `communityHub-elegant`, `communityHub-expansive`, `communityHub-impact`, `communityHub-elegant`, `communityHub-active`, `appeal-basic`, `appeal-modern`, `appeal-elegant`, `appeal-expansive`, `appeal-impact`, `appeal-elegant`, `appeal-active`, `special-virtualEvent`, `special-virtualAppeal`, `special-charityChallenge`
    - `urls` unknown[] — Custom domains of the campaign Example: `[ "yourdomain.com" ]`
      - unknown
    - `version` string — Theme version Example: `3.0.0`

## Other responses

- `401` — Authorization credentials were missing or invalid
- `403` — The user is authenticated, but is not allowed to perform the requested operation
- `410` — The requested record no longer exists, or that API has been deprecated
- `429` — You have made too many requests to the given endpoint, please try again later
- `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com

---

[API](https://skmtc.dev/raisely/apis/raisely-api.md) · [All operations](https://skmtc.dev/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/raisely/raisely-api/revisions/d7f8dd294cb0/schema)