{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"name": [
"The name field is required."
]
},
"instance": "/api/Campaign/88"
}
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Campaign/{id}"
}
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"name": [
"The name field is required."
]
},
"instance": "/api/Campaign/88"
}
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Campaign/{id}"
}
Send the campaign’s full representation in the body: name, description, the startDate/endDate range, and the goal fields you want in place (givingGoal, totalGiftGoal, averageGiftGoal) with their matching has* flags. Returns the updated campaign.
Authorizations
Authorization
string
header
required
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Path Parameters
id
integer<int64>
required
The ID of the campaign.
Body
application/jsontext/jsonapplication/*+json
The campaign update request.
name
string
required
The name of the campaign.
Minimum string length: 1
startDate
string<date-time>
required
The date the campaign starts.
Minimum string length: 1
endDate
string<date-time>
required
The date the campaign ends.
Minimum string length: 1
description
string | null
The description of the campaign.
startDateTimeUtc
string<date-time>
The UTC date and time the campaign starts. Send it instead of startDate to set the time as well.
endDateTimeUtc
string<date-time>
The UTC date and time the campaign ends. Send it instead of endDate to set the time as well.
givingGoal
number<double>
The giving goal for the campaign in the organization base currency.
hasGivingGoal
boolean
Whether the campaign has a giving goal. Set it to true for givingGoal to be tracked.
totalGiftGoal
integer<int32>
The number of gifts the campaign aims to bring in.
hasTotalGiftGoal
boolean
Whether the campaign has a total gift goal. Set it to true for totalGiftGoal to be tracked.
averageGiftGoal
number<double>
The target average gift amount in the organization base currency.
hasAverageGiftGoal
boolean
Whether the campaign has an average gift goal. Set it to true for averageGiftGoal to be tracked.
crmKey
string | null
The key that links the campaign to the matching record in your CRM.
crmKeys
object | null
The keys that link the campaign to matching records in your CRM, by CRM.
Show child attributes
applySegmentToRecurringGifts
boolean
Whether the segment applies to recurring gifts.
canSync
boolean
Whether the campaign can sync to your CRM.
segments
object[] | null
The segments to create with the campaign.
Show child attributes
Response
OK
Represents the detailed view of a campaign returned by create, update, and
single-campaign retrieval endpoints.
id
integer<int64>
The unique identifier of the campaign.
name
string | null
The name of the campaign.
description
string | null
The description of the campaign.
startDate
string | null
read-only
The date the campaign starts.
endDate
string | null
read-only
The date the campaign ends.
duration
string | null
read-only
The length of the campaign in days.
canSync
boolean
read-only
Whether the campaign can sync to your CRM.
crmKey
string | null
The key that links the campaign to the matching record in your CRM.
crmKeyUrls
object | null
CRM URLs for this campaign grouped by integration type.
Show child attributes
applySegmentToRecurringGifts
boolean
Whether the segment applies to recurring gifts.
givingGoal
number<double>
The giving goal for the campaign in the organization base currency.
givingGoalFormatted
string | null
read-only
The giving goal formatted for display in the organization currency (for example "$10,000.00").
hasGivingGoal
boolean
Whether the campaign has a giving goal.
raisedAmount
string | null
read-only
The total amount raised by the campaign.
raisedPercentage
number<double>
read-only
Percentage of the giving goal that has been raised (0–100).
totalGiftGoal
integer<int32>
The number of gifts the campaign aims to bring in.
hasTotalGiftGoal
boolean
Whether the campaign has a total gift goal.
totalGifts
integer<int32>
read-only
The number of gifts recorded for the campaign.
totalGiftsPercentage
number<double>
read-only
Percentage of the gift count goal that has been reached (0–100).
totalDonors
integer<int32>
read-only
The number of donors who have given to the campaign.
averageGiftGoal
number<double>
The target average gift amount in the organization base currency.
averageGiftGoalFormatted
string | null
read-only
The target average gift amount formatted for display (for example "$100.00").
averageGiftAmount
string | null
read-only
The actual average gift amount formatted for display.
hasAverageGiftGoal
boolean
Whether the campaign has an average gift goal.
totalVisitors
integer<int32>
read-only
The number of visitors recorded for the campaign.
conversionRate
string | null
read-only
The conversion rate for the campaign formatted as a percentage string (for example "12.3%").
createdDateTime
string | null
read-only
The UTC date and time the campaign was created.
modifiedDateTime
string | null
read-only
The UTC date and time the campaign was last modified.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Virtuous API Docs","colors":{"primary":"#00A3E0","light":"#00A3E0","dark":"#00A3E0"},"logo":{"light":"https://mintcdn.com/virtuous-7a5d9ba3/3Z-OfpCv07Qt6t9Z/logo/light.svg?fit=max\u0026auto=format\u0026n=3Z-OfpCv07Qt6t9Z\u0026q=85\u0026s=a4a7a0098ed125e3782554092ea0c518","dark":"https://mintcdn.com/virtuous-7a5d9ba3/3Z-OfpCv07Qt6t9Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=3Z-OfpCv07Qt6t9Z\u0026q=85\u0026s=942d0c1a195f85aa0edf4f6fbd3d5413","href":"https://virtuous.org"},"favicon":"https://mintcdn.com/virtuous-7a5d9ba3/3Z-OfpCv07Qt6t9Z/favicon.png?fit=max\u0026auto=format\u0026n=3Z-OfpCv07Qt6t9Z\u0026q=85\u0026s=4fd5393f4a0f0339258c9a2caad66f77","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["bash","javascript","python","dotnet","php","java","ruby","node"],"prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"light"},"background":{"decoration":"windows","color":{"dark":"#081F2C"}},"navbar":{"links":[{"href":"https://app.virtuoussoftware.com/Account/Login","label":"Login"}],"primary":{"type":"button","label":"Request a Demo","href":"https://virtuous.org/schedule-a-demo/"}},"footer":{"socials":{"x":"https://x.com/virtuouscrm","facebook":"https://www.facebook.com/virtuouscrm","linkedin":"https://www.linkedin.com/company/virtuous","youtube":"https://www.youtube.com/VirtuousSoftware","instagram":"https://www.instagram.com/virtuouscrm"},"links":[{"header":"CRM","items":[{"label":"Login","href":"https://app.virtuoussoftware.com/Account/Login"},{"label":"Features","href":"https://virtuous.org/software/crm"},{"label":"Help Center","href":"https://support.virtuous.org/hc/en-us"}]},{"header":"RAISE","items":[{"label":"Login","href":"https://app.raisedonors.com/"},{"label":"Features","href":"https://explore.raisedonors.com/"},{"label":"Help Center","href":"https://help.raisedonors.com/hc/en-us"}]},{"header":"VOLUNTEER","items":[{"label":"Login","href":"https://app.vomo.org/login"},{"label":"Features","href":"https://virtuous.org/software/volunteer"},{"label":"Help Center","href":"https://support.vomo.org/hc/en-us"}]}]},"seo":{"metatags":{"robots":"noindex"}},"fonts":{"family":"Inter","format":"woff2"},"errors":{"404":{"redirect":false,"title":"Page Not Found"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":false},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"chart-simple","href":"https://virtuous.org/system-status/"},{"anchor":"Help Center","icon":"headset","href":"https://virtuous.org/resources/help-center"},{"anchor":"Product Hub","icon":"newspaper","href":"https://product.virtuous.org/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"virtuous-7a5d9ba3","hasAudioNarration":false,"actualSubdomain":"virtuous-7a5d9ba3","customDomains":["docs.virtuous.org"],"gitSource":{"type":"github","owner":"virtuouscrm","repo":"api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b007f5089d041245aff48e0","clientVersion":"0.0.4269","searchFilterCounts":[{"language":"default","tag":"API Reference","count":468},{"language":"default","tag":"Virtuous CRM+","count":352},{"language":"default","tag":"Virtuous RAISE","count":181},{"language":"default","tag":"Guides","count":140},{"language":"default","tag":"Contacts and Individuals","count":98},{"language":"default","tag":"Virtuous VOLUNTEER","count":66},{"language":"default","tag":"Giving","count":63},{"language":"default","tag":"Donor","count":46},{"language":"default","tag":"Projects","count":34},{"language":"default","tag":"Workflows","count":26}],"searchSettings":{"showContentSnippets":true,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"integrations@virtuous.org"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#page-title{color:#243746}.dark #page-title{color:#FFFFFF}"}]}
{"page":{"pagePath":"api-reference/campaign/update-a-campaign","slug":"/api-reference/campaign/update-a-campaign","pageMetadata":{"title":"Update a Campaign","description":"Updates a campaign.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Campaign/{id}","href":"/api-reference/campaign/update-a-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a campaign.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Send the campaign’s full representation in the body: `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`description`}),`, the `,_jsx(_components.code,{children:`startDate`}),`/`,_jsx(_components.code,{children:`endDate`}),` range, and the goal fields you want in place (`,_jsx(_components.code,{children:`givingGoal`}),`, `,_jsx(_components.code,{children:`totalGiftGoal`}),`, `,_jsx(_components.code,{children:`averageGiftGoal`}),`) with their matching `,_jsx(_components.code,{children:`has*`}),` flags. Returns the updated campaign.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a Campaign","description":"Updates a campaign.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Campaign/{id}","href":"/api-reference/campaign/update-a-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Campaign"],"summary":"Update a Campaign","description":"Updates a campaign.","x-mint":{"content":"Send the campaign's full representation in the body: `name`, `description`, the `startDate`/`endDate` range, and the goal fields you want in place (`givingGoal`, `totalGiftGoal`, `averageGiftGoal`) with their matching `has*` flags. Returns the updated campaign."},"operationId":"Campaign_UpdateCampaign","parameters":["177baa7d-cb49-4716-8582-9f9f114639c6"],"requestBody":"9f1bc4e1-51d1-4be5-912f-f1972cab056f","responses":{"200":"baa13f75-767f-4559-bfdb-20b75cfd44ee","400":"804684ea-1ea4-4a58-ae8c-af23770116d3","401":"377142c7-a717-4f23-bf84-364ef35cb7bf"},"method":"put","type":"path","servers":["7fc714ab-a0a9-4ef9-b33d-fc58ed75e30b"],"security":["5d71430c-ca7b-441a-b139-8379d412a3ab"],"path":"/api/Campaign/{id}","baseUrlOptions":["https://prod-api.raisedonors.com"],"title":"Update a Campaign","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","dotnet","php","java","ruby","node"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"\u003cstring>","body.startDate":"2023-11-07T05:31:56Z","body.endDate":"2023-11-07T05:31:56Z","body.description.oneOf.0":"\u003cstring>","body.startDateTimeUtc":"2023-11-07T05:31:56Z","body.endDateTimeUtc":"2023-11-07T05:31:56Z","body.givingGoal":123,"body.hasGivingGoal":true,"body.totalGiftGoal":123,"body.hasTotalGiftGoal":true,"body.averageGiftGoal":123,"body.hasAverageGiftGoal":true,"body.crmKey.oneOf.0":"\u003cstring>","body.applySegmentToRecurringGifts":true,"body.canSync":true,"body.segments.oneOf.0.items.0.campaignId":123,"body.segments.oneOf.0.items.0.name":"\u003cstring>","body.segments.oneOf.0.items.0.code":"\u003cstring>","body.segments.oneOf.0.items.0.description.oneOf.0":"\u003cstring>","body.segments.oneOf.0.items.0.externalIdentifier.oneOf.0":"\u003cstring>"}],"urlDisplay":"full"},"dependencies":{"parameters":{"177baa7d-cb49-4716-8582-9f9f114639c6":{"name":"id","in":"path","description":"The ID of the campaign.","required":true,"schema":{"type":"integer","format":"int64","isRequired":true,"description":"The ID of the campaign.","uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"requestBody":{"description":"The campaign update request.","content":{"application/json":{"schema":{"type":"object","required":["endDate","name","startDate"],"properties":{"name":{"minLength":1,"type":"string","description":"The name of the campaign.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"startDate":{"minLength":1,"type":"string","description":"The date the campaign starts.","format":"date-time","isRequired":true,"uniqueKey":"startDate","typeLabel":"string\u003cdate-time>"},"endDate":{"minLength":1,"type":"string","description":"The date the campaign ends.","format":"date-time","isRequired":true,"uniqueKey":"endDate","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign starts. Send it instead of `startDate` to set the time as well.","format":"date-time","uniqueKey":"startDateTimeUtc","typeLabel":"string\u003cdate-time>"},"endDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign ends. Send it instead of `endDate` to set the time as well.","format":"date-time","uniqueKey":"endDateTimeUtc","typeLabel":"string\u003cdate-time>"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal. Set it to true for `givingGoal` to be tracked.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal. Set it to true for `totalGiftGoal` to be tracked.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal. Set it to true for `averageGiftGoal` to be tracked.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeys":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeys","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","uniqueKey":"canSync","typeLabel":"boolean"},"segments":{"oneOf":[{"type":"array","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].campaignId","typeLabel":"integer\u003cint64>"},"name":{"minLength":1,"type":"string","description":"The name of the segment.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].name","typeLabel":"string"},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].code","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"segments.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the segment."},"description":{"oneOf":[{"type":"string","description":"The description of the segment."},{"type":"null","description":"The description of the segment."}]},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free."},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system."},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system."}]}},"additionalProperties":false},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","startDate":"2023-11-07T05:31:56Z","endDate":"2023-11-07T05:31:56Z","description":"\u003cstring>","startDateTimeUtc":"2023-11-07T05:31:56Z","endDateTimeUtc":"2023-11-07T05:31:56Z","givingGoal":123,"hasGivingGoal":true,"totalGiftGoal":123,"hasTotalGiftGoal":true,"averageGiftGoal":123,"hasAverageGiftGoal":true,"crmKey":"\u003cstring>","crmKeys":{},"applySegmentToRecurringGifts":true,"canSync":true,"segments":[{"campaignId":123,"name":"\u003cstring>","code":"\u003cstring>","description":"\u003cstring>","externalIdentifier":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","required":["endDate","name","startDate"],"properties":{"name":{"minLength":1,"type":"string","description":"The name of the campaign.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"startDate":{"minLength":1,"type":"string","description":"The date the campaign starts.","format":"date-time","isRequired":true,"uniqueKey":"startDate","typeLabel":"string\u003cdate-time>"},"endDate":{"minLength":1,"type":"string","description":"The date the campaign ends.","format":"date-time","isRequired":true,"uniqueKey":"endDate","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign starts. Send it instead of `startDate` to set the time as well.","format":"date-time","uniqueKey":"startDateTimeUtc","typeLabel":"string\u003cdate-time>"},"endDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign ends. Send it instead of `endDate` to set the time as well.","format":"date-time","uniqueKey":"endDateTimeUtc","typeLabel":"string\u003cdate-time>"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal. Set it to true for `givingGoal` to be tracked.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal. Set it to true for `totalGiftGoal` to be tracked.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal. Set it to true for `averageGiftGoal` to be tracked.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeys":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeys","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","uniqueKey":"canSync","typeLabel":"boolean"},"segments":{"oneOf":[{"type":"array","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].campaignId","typeLabel":"integer\u003cint64>"},"name":{"minLength":1,"type":"string","description":"The name of the segment.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].name","typeLabel":"string"},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].code","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"segments.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the segment."},"description":{"oneOf":[{"type":"string","description":"The description of the segment."},{"type":"null","description":"The description of the segment."}]},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free."},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system."},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system."}]}},"additionalProperties":false},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","startDate":"2023-11-07T05:31:56Z","endDate":"2023-11-07T05:31:56Z","description":"\u003cstring>","startDateTimeUtc":"2023-11-07T05:31:56Z","endDateTimeUtc":"2023-11-07T05:31:56Z","givingGoal":123,"hasGivingGoal":true,"totalGiftGoal":123,"hasTotalGiftGoal":true,"averageGiftGoal":123,"hasAverageGiftGoal":true,"crmKey":"\u003cstring>","crmKeys":{},"applySegmentToRecurringGifts":true,"canSync":true,"segments":[{"campaignId":123,"name":"\u003cstring>","code":"\u003cstring>","description":"\u003cstring>","externalIdentifier":"\u003cstring>"}]}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","required":["endDate","name","startDate"],"properties":{"name":{"minLength":1,"type":"string","description":"The name of the campaign.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"startDate":{"minLength":1,"type":"string","description":"The date the campaign starts.","format":"date-time","isRequired":true,"uniqueKey":"startDate","typeLabel":"string\u003cdate-time>"},"endDate":{"minLength":1,"type":"string","description":"The date the campaign ends.","format":"date-time","isRequired":true,"uniqueKey":"endDate","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign starts. Send it instead of `startDate` to set the time as well.","format":"date-time","uniqueKey":"startDateTimeUtc","typeLabel":"string\u003cdate-time>"},"endDateTimeUtc":{"type":"string","description":"The UTC date and time the campaign ends. Send it instead of `endDate` to set the time as well.","format":"date-time","uniqueKey":"endDateTimeUtc","typeLabel":"string\u003cdate-time>"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal. Set it to true for `givingGoal` to be tracked.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal. Set it to true for `totalGiftGoal` to be tracked.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal. Set it to true for `averageGiftGoal` to be tracked.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeys":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"crmKeys.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The keys that link the campaign to matching records in your CRM, by CRM.","uniqueKey":"crmKeys.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeys","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","uniqueKey":"canSync","typeLabel":"boolean"},"segments":{"oneOf":[{"type":"array","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].campaignId","typeLabel":"integer\u003cint64>"},"name":{"minLength":1,"type":"string","description":"The name of the segment.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].name","typeLabel":"string"},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free.","isRequired":true,"uniqueKey":"segments.oneOf.0.items.[INDEX].code","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the segment.","uniqueKey":"segments.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system.","uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments.oneOf.0.items.[INDEX].externalIdentifier","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"segments.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["campaignId","code","name"],"type":"object","properties":{"campaignId":{"type":"integer","description":"The unique identifier of the campaign the segment belongs to.","format":"int64"},"name":{"minLength":1,"type":"string","description":"The name of the segment."},"description":{"oneOf":[{"type":"string","description":"The description of the segment."},{"type":"null","description":"The description of the segment."}]},"code":{"minLength":1,"type":"string","description":"The code that identifies the segment. Use Check if Segment Code Exists first to make sure it is free."},"externalIdentifier":{"oneOf":[{"type":"string","description":"An identifier of your own to store on the segment, for reconciling it with an external system."},{"type":"null","description":"An identifier of your own to store on the segment, for reconciling it with an external system."}]}},"additionalProperties":false},"description":"The segments to create with the campaign.","uniqueKey":"segments.oneOf.1","typeLabel":"null"}],"uniqueKey":"segments","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","startDate":"2023-11-07T05:31:56Z","endDate":"2023-11-07T05:31:56Z","description":"\u003cstring>","startDateTimeUtc":"2023-11-07T05:31:56Z","endDateTimeUtc":"2023-11-07T05:31:56Z","givingGoal":123,"hasGivingGoal":true,"totalGiftGoal":123,"hasTotalGiftGoal":true,"averageGiftGoal":123,"hasAverageGiftGoal":true,"crmKey":"\u003cstring>","crmKeys":{},"applySegmentToRecurringGifts":true,"canSync":true,"segments":[{"campaignId":123,"name":"\u003cstring>","code":"\u003cstring>","description":"\u003cstring>","externalIdentifier":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"baa13f75-767f-4559-bfdb-20b75cfd44ee":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the campaign.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the campaign.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the campaign.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"startDate","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"endDate","typeLabel":"string | null"},"duration":{"oneOf":[{"type":"string","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.0","typeLabel":"string"},{"type":"null","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"duration","typeLabel":"string | null"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","readOnly":true,"uniqueKey":"canSync","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeyUrls":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"givingGoalFormatted":{"oneOf":[{"type":"string","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingGoalFormatted","typeLabel":"string | null"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"raisedAmount":{"oneOf":[{"type":"string","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"raisedAmount","typeLabel":"string | null"},"raisedPercentage":{"type":"number","description":"Percentage of the giving goal that has been raised (0–100).","format":"double","readOnly":true,"uniqueKey":"raisedPercentage","typeLabel":"number\u003cdouble>"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"totalGifts":{"type":"integer","description":"The number of gifts recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalGifts","typeLabel":"integer\u003cint32>"},"totalGiftsPercentage":{"type":"number","description":"Percentage of the gift count goal that has been reached (0–100).","format":"double","readOnly":true,"uniqueKey":"totalGiftsPercentage","typeLabel":"number\u003cdouble>"},"totalDonors":{"type":"integer","description":"The number of donors who have given to the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalDonors","typeLabel":"integer\u003cint32>"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"averageGiftGoalFormatted":{"oneOf":[{"type":"string","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftGoalFormatted","typeLabel":"string | null"},"averageGiftAmount":{"oneOf":[{"type":"string","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftAmount","typeLabel":"string | null"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"totalVisitors":{"type":"integer","description":"The number of visitors recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalVisitors","typeLabel":"integer\u003cint32>"},"conversionRate":{"oneOf":[{"type":"string","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversionRate","typeLabel":"string | null"},"createdDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDateTime","typeLabel":"string | null"},"modifiedDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDateTime","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the detailed view of a campaign returned by create, update, and\nsingle-campaign retrieval endpoints.","uniqueKey":"","typeLabel":"object"},"example":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"},"examples":{"Example":{"title":"Example","value":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the campaign.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the campaign.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the campaign.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"startDate","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"endDate","typeLabel":"string | null"},"duration":{"oneOf":[{"type":"string","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.0","typeLabel":"string"},{"type":"null","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"duration","typeLabel":"string | null"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","readOnly":true,"uniqueKey":"canSync","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeyUrls":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"givingGoalFormatted":{"oneOf":[{"type":"string","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingGoalFormatted","typeLabel":"string | null"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"raisedAmount":{"oneOf":[{"type":"string","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"raisedAmount","typeLabel":"string | null"},"raisedPercentage":{"type":"number","description":"Percentage of the giving goal that has been raised (0–100).","format":"double","readOnly":true,"uniqueKey":"raisedPercentage","typeLabel":"number\u003cdouble>"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"totalGifts":{"type":"integer","description":"The number of gifts recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalGifts","typeLabel":"integer\u003cint32>"},"totalGiftsPercentage":{"type":"number","description":"Percentage of the gift count goal that has been reached (0–100).","format":"double","readOnly":true,"uniqueKey":"totalGiftsPercentage","typeLabel":"number\u003cdouble>"},"totalDonors":{"type":"integer","description":"The number of donors who have given to the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalDonors","typeLabel":"integer\u003cint32>"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"averageGiftGoalFormatted":{"oneOf":[{"type":"string","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftGoalFormatted","typeLabel":"string | null"},"averageGiftAmount":{"oneOf":[{"type":"string","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftAmount","typeLabel":"string | null"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"totalVisitors":{"type":"integer","description":"The number of visitors recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalVisitors","typeLabel":"integer\u003cint32>"},"conversionRate":{"oneOf":[{"type":"string","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversionRate","typeLabel":"string | null"},"createdDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDateTime","typeLabel":"string | null"},"modifiedDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDateTime","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the detailed view of a campaign returned by create, update, and\nsingle-campaign retrieval endpoints.","uniqueKey":"","typeLabel":"object"},"example":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"},"examples":{"Example":{"title":"Example","value":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of the campaign.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the campaign.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the campaign.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the campaign.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the campaign.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign starts.","readOnly":true,"uniqueKey":"startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"startDate","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the campaign ends.","readOnly":true,"uniqueKey":"endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"endDate","typeLabel":"string | null"},"duration":{"oneOf":[{"type":"string","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.0","typeLabel":"string"},{"type":"null","description":"The length of the campaign in days.","readOnly":true,"uniqueKey":"duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"duration","typeLabel":"string | null"},"canSync":{"type":"boolean","description":"Whether the campaign can sync to your CRM.","readOnly":true,"uniqueKey":"canSync","typeLabel":"boolean"},"crmKey":{"oneOf":[{"type":"string","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key that links the campaign to the matching record in your CRM.","uniqueKey":"crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKey","typeLabel":"string | null"},"crmKeyUrls":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.0.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"crmKey":{"oneOf":[{"type":"string","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.crmKey","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to the matching record in the CRM.","uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties.url","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"crmKeyUrls.oneOf.1.additionalProperties","typeLabel":"object"},"description":"CRM URLs for this campaign grouped by integration type.","uniqueKey":"crmKeyUrls.oneOf.1","typeLabel":"null"}],"uniqueKey":"crmKeyUrls","typeLabel":"object | null"},"applySegmentToRecurringGifts":{"type":"boolean","description":"Whether the segment applies to recurring gifts.","uniqueKey":"applySegmentToRecurringGifts","typeLabel":"boolean"},"givingGoal":{"type":"number","description":"The giving goal for the campaign in the organization base currency.","format":"double","uniqueKey":"givingGoal","typeLabel":"number\u003cdouble>"},"givingGoalFormatted":{"oneOf":[{"type":"string","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The giving goal formatted for display in the organization currency (for example \"$10,000.00\").","readOnly":true,"uniqueKey":"givingGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"givingGoalFormatted","typeLabel":"string | null"},"hasGivingGoal":{"type":"boolean","description":"Whether the campaign has a giving goal.","uniqueKey":"hasGivingGoal","typeLabel":"boolean"},"raisedAmount":{"oneOf":[{"type":"string","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The total amount raised by the campaign.","readOnly":true,"uniqueKey":"raisedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"raisedAmount","typeLabel":"string | null"},"raisedPercentage":{"type":"number","description":"Percentage of the giving goal that has been raised (0–100).","format":"double","readOnly":true,"uniqueKey":"raisedPercentage","typeLabel":"number\u003cdouble>"},"totalGiftGoal":{"type":"integer","description":"The number of gifts the campaign aims to bring in.","format":"int32","uniqueKey":"totalGiftGoal","typeLabel":"integer\u003cint32>"},"hasTotalGiftGoal":{"type":"boolean","description":"Whether the campaign has a total gift goal.","uniqueKey":"hasTotalGiftGoal","typeLabel":"boolean"},"totalGifts":{"type":"integer","description":"The number of gifts recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalGifts","typeLabel":"integer\u003cint32>"},"totalGiftsPercentage":{"type":"number","description":"Percentage of the gift count goal that has been reached (0–100).","format":"double","readOnly":true,"uniqueKey":"totalGiftsPercentage","typeLabel":"number\u003cdouble>"},"totalDonors":{"type":"integer","description":"The number of donors who have given to the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalDonors","typeLabel":"integer\u003cint32>"},"averageGiftGoal":{"type":"number","description":"The target average gift amount in the organization base currency.","format":"double","uniqueKey":"averageGiftGoal","typeLabel":"number\u003cdouble>"},"averageGiftGoalFormatted":{"oneOf":[{"type":"string","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.0","typeLabel":"string"},{"type":"null","description":"The target average gift amount formatted for display (for example \"$100.00\").","readOnly":true,"uniqueKey":"averageGiftGoalFormatted.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftGoalFormatted","typeLabel":"string | null"},"averageGiftAmount":{"oneOf":[{"type":"string","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actual average gift amount formatted for display.","readOnly":true,"uniqueKey":"averageGiftAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"averageGiftAmount","typeLabel":"string | null"},"hasAverageGiftGoal":{"type":"boolean","description":"Whether the campaign has an average gift goal.","uniqueKey":"hasAverageGiftGoal","typeLabel":"boolean"},"totalVisitors":{"type":"integer","description":"The number of visitors recorded for the campaign.","format":"int32","readOnly":true,"uniqueKey":"totalVisitors","typeLabel":"integer\u003cint32>"},"conversionRate":{"oneOf":[{"type":"string","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The conversion rate for the campaign formatted as a percentage string (for example \"12.3%\").","readOnly":true,"uniqueKey":"conversionRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversionRate","typeLabel":"string | null"},"createdDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was created.","readOnly":true,"uniqueKey":"createdDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDateTime","typeLabel":"string | null"},"modifiedDateTime":{"oneOf":[{"type":"string","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UTC date and time the campaign was last modified.","readOnly":true,"uniqueKey":"modifiedDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDateTime","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the detailed view of a campaign returned by create, update, and\nsingle-campaign retrieval endpoints.","uniqueKey":"","typeLabel":"object"},"example":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"},"examples":{"Example":{"title":"Example","value":{"id":88,"name":"Year-End Giving 2025","description":"Year-end multi-channel giving campaign.","startDate":"2025-11-01","endDate":"2025-12-31","duration":"60","canSync":true,"crmKey":"2011","crmKeyUrls":{"VirtuousCRM":{"crmKey":"2011","url":"https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"}},"applySegmentToRecurringGifts":true,"givingGoal":250000,"givingGoalFormatted":"$250,000.00","hasGivingGoal":true,"raisedAmount":"$87,340.00","raisedPercentage":34.9,"totalGiftGoal":600,"hasTotalGiftGoal":true,"totalGifts":467,"totalGiftsPercentage":77.8,"totalDonors":412,"averageGiftGoal":250,"averageGiftGoalFormatted":"$250.00","averageGiftAmount":"$187.02","hasAverageGiftGoal":true,"totalVisitors":5842,"conversionRate":"8.0%","createdDateTime":"2025-10-15T09:00:00Z","modifiedDateTime":"2025-11-15T08:00:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"804684ea-1ea4-4a58-ae8c-af23770116d3":{"description":"Bad Request — the campaign was not updated. A non-numeric `id`, a missing required field, or a value outside its accepted range all produce this; the `errors` map names the fields that failed. The stored campaign is unchanged.","content":{"text/plain":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"}}},"exampleType":"examples"},"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"}}},"exampleType":"examples"},"text/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.0.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.0.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"oneOf.1.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"oneOf.1.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"oneOf.1.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"oneOf.1.instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"description":"The validation errors, keyed by the field they apply to.","uniqueKey":"oneOf.1.errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7231#section-6.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"name":["The name field is required."]},"instance":"/api/Campaign/88"}}},"exampleType":"examples"}},"exampleType":"examples"},"377142c7-a717-4f23-bf84-364ef35cb7bf":{"description":"Unauthorized — the `Authorization` header is missing, or the bearer token is malformed, expired, or revoked. Every Raise endpoint requires authentication, so this can be returned in place of any other response. Retrying with the same credential fails the same way — replace the token first. See [Authentication](/raise/authentication).","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the type of problem.","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"A short summary of the problem.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short summary of the problem.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP status code of the response.","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"An explanation of what went wrong with this specific request.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URI identifying the request that produced the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"},"examples":{"Example":{"title":"Example","value":{"type":"https://tools.ietf.org/html/rfc7235#section-3.1","title":"Unauthorized","status":401,"detail":"The Authorization header is missing, malformed, or carries a token that is expired or revoked.","instance":"/api/Campaign/{id}"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"5d71430c-ca7b-441a-b139-8379d412a3ab":{"Bearer":{"type":"apiKey","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"","name":"Authorization","in":"header","scopes":[],"schemeName":"Bearer"}}},"servers":{"7fc714ab-a0a9-4ef9-b33d-fc58ed75e30b":{"url":"https://prod-api.raisedonors.com","description":"Production API for RaiseDonors"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"","name":"Authorization","in":"header","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"raise/RaiseAPIOpenAPI.json"},"subdomain":"virtuous-7a5d9ba3","siteName":"Virtuous API Docs","title":"Update a Campaign - Virtuous API Docs","relatedPagesConfig":{"enabled":true,"limit":4,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{},"searchTabScopes":[{"product":"Virtuous","tab":"Guides"},{"product":"Virtuous","tab":"Partners"},{"product":"Virtuous","tab":"MCP"},{"product":"Virtuous","tab":"Glossary"},{"product":"Virtuous CRM+","tab":"Guides"},{"product":"Virtuous CRM+","tab":"API Reference"},{"product":"Virtuous CRM+","tab":"Changelog"},{"product":"Virtuous RAISE","tab":"Guides"},{"product":"Virtuous RAISE","tab":"API Reference"},{"product":"Virtuous RAISE","tab":"Changelog"},{"product":"Virtuous ANALYTICS","tab":"Data Models"},{"product":"Virtuous ANALYTICS","tab":"Changelog"},{"product":"Virtuous VOLUNTEER","tab":"Guides"},{"product":"Virtuous VOLUNTEER","tab":"API Reference"},{"product":"Virtuous VOLUNTEER","tab":"Changelog"},{"product":"Virtuous MOMENTUM","tab":"Guides"},{"product":"Virtuous MOMENTUM","tab":"Changelog"}]},"originalFileLocation":"api-reference/campaign/update-a-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates a campaign.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Virtuous API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a Campaign - Virtuous API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a campaign.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Virtuous API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://virtuous-7a5d9ba3.mintlify.site/_mintlify/api/og/v2?division=Campaign\u0026amp;title=Update+a+Campaign\u0026amp;description=Updates+a+campaign.\u0026amp;theme=483f305e7e8c97e32e572c97\u0026amp;signature=2b661c585c8d37821694e486e67f2857b8d4d2d26d9b62358875a51c3d9ea71c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a Campaign - Virtuous API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a campaign.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://virtuous-7a5d9ba3.mintlify.site/_mintlify/api/og/v2?division=Campaign\u0026amp;title=Update+a+Campaign\u0026amp;description=Updates+a+campaign.\u0026amp;theme=483f305e7e8c97e32e572c97\u0026amp;signature=2b661c585c8d37821694e486e67f2857b8d4d2d26d9b62358875a51c3d9ea71c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/virtuous-7a5d9ba3/vpUGFW8SOljP6x0V/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Virtuous API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00A3E0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campaign/update-a-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.virtuous.org/#organization\",\"name\":\"Virtuous API Docs\",\"url\":\"https://docs.virtuous.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/virtuous-7a5d9ba3/3Z-OfpCv07Qt6t9Z/logo/light.svg?fit=max\u0026auto=format\u0026n=3Z-OfpCv07Qt6t9Z\u0026q=85\u0026s=a4a7a0098ed125e3782554092ea0c518\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.virtuous.org#website\",\"name\":\"Virtuous API Docs\",\"url\":\"https://docs.virtuous.org\",\"publisher\":{\"@id\":\"https://docs.virtuous.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign#webpage\",\"url\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign\",\"name\":\"Update a Campaign\",\"description\":\"Updates a campaign.\",\"isPartOf\":{\"@id\":\"https://docs.virtuous.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Campaign\",\"item\":\"https://docs.virtuous.org/api-reference/campaign/list-all-campaigns\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a Campaign\",\"item\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign#apireference\",\"headline\":\"Update a Campaign\",\"name\":\"Update a Campaign\",\"description\":\"Updates a campaign.\",\"url\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.virtuous.org/api-reference/campaign/update-a-campaign#webpage\"},\"publisher\":{\"@id\":\"https://docs.virtuous.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.virtuous.org#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/campaign/update-a-campaign.md","siteName":"Virtuous API Docs","nav":{"global":{"anchors":[{"anchor":"Status","icon":"chart-simple","href":"https://virtuous.org/system-status/"},{"anchor":"Help Center","icon":"headset","href":"https://virtuous.org/resources/help-center"},{"anchor":"Product Hub","icon":"newspaper","href":"https://product.virtuous.org/"}]},"products":[{"product":"Virtuous","pages":[{"title":"Virtuous","href":""}]},{"product":"Virtuous CRM+","color":{"light":"#00a3e3","dark":"#00a3e3"},"pages":[{"title":"Virtuous CRM+","href":"/crm/overview"}]},{"product":"Virtuous RAISE","color":{"light":"#00a3e3","dark":"#00a3e3"},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/raise/overview"}]},{"tab":"API Reference","groups":[{"group":"Activity","pages":[{"title":"List Donor Activities","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Activity/list","href":"/api-reference/activity/list-donor-activities"}]},{"group":"Campaign","pages":[{"title":"List All Campaigns","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Campaign/list","href":"/api-reference/campaign/list-all-campaigns"},{"title":"Get a Campaign","description":"Returns a single campaign by ID, including its goals and the totals raised against them.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Campaign/{id}","href":"/api-reference/campaign/get-a-campaign"},{"title":"Update a Campaign","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Campaign/{id}","href":"/api-reference/campaign/update-a-campaign"},{"title":"Delete a Campaign","description":"Deletes a campaign.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Campaign/{id}","href":"/api-reference/campaign/delete-a-campaign"},{"title":"Create a Campaign","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Campaign","href":"/api-reference/campaign/create-a-campaign"},{"title":"Get Campaign Dependency Count","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Campaign/{campaignId}/dependency-count","href":"/api-reference/campaign/get-campaign-dependency-count"},{"title":"Replace a Campaign","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Campaign/replace","href":"/api-reference/campaign/replace-a-campaign"},{"title":"Toggle Campaign Sync","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Campaign/{campaignId}/toggle-sync","href":"/api-reference/campaign/toggle-campaign-sync"},{"title":"Query Campaigns","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Campaign/query","href":"/api-reference/campaign/query-campaigns"}]},{"group":"CustomField","pages":[{"title":"List All Custom Fields","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/CustomField/List","href":"/api-reference/customfield/list-all-custom-fields"},{"title":"Get a Custom Field","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/CustomField/{id}","href":"/api-reference/customfield/get-a-custom-field"},{"title":"Update a Custom Field","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/CustomField/{id}","href":"/api-reference/customfield/update-a-custom-field"},{"title":"Delete a Custom Field","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/CustomField/{id}","href":"/api-reference/customfield/delete-a-custom-field"},{"title":"Create a Custom Field","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/CustomField","href":"/api-reference/customfield/create-a-custom-field"},{"title":"Get Custom Field Dependency Count","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/CustomField/{id}/dependency-count","href":"/api-reference/customfield/get-custom-field-dependency-count"}]},{"group":"Donor","pages":[{"title":"Get a Donor","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}","href":"/api-reference/donor/get-a-donor"},{"title":"List All Donors","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/list","href":"/api-reference/donor/list-all-donors"},{"title":"Query Donors","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/query","href":"/api-reference/donor/query-donors"},{"title":"Search Donors","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/search","href":"/api-reference/donor/search-donors"},{"title":"Update a Donor","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}","href":"/api-reference/donor/update-a-donor"},{"title":"Partially Update a Donor","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json patch /api/Donor/{id}","href":"/api-reference/donor/partially-update-a-donor"},{"title":"Archive a Donor","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/archive","href":"/api-reference/donor/archive-a-donor"},{"title":"Merge Donors","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/merge","href":"/api-reference/donor/merge-donors"},{"title":"Update Donor Notes","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{donorId}/notes","href":"/api-reference/donor/update-donor-notes"},{"title":"Get a Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/address/{addressId}","href":"/api-reference/donor/get-a-donor-address"},{"title":"Partially Update a Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json patch /api/Donor/{id}/address/{addressId}","href":"/api-reference/donor/partially-update-a-donor-address"},{"title":"Create a Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/address","href":"/api-reference/donor/create-a-donor-address"},{"title":"Update a Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/address/{addressId}/update","href":"/api-reference/donor/update-a-donor-address"},{"title":"Delete a Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Donor/{id}/address/{addressId}/delete","href":"/api-reference/donor/delete-a-donor-address"},{"title":"List Donor Addresses","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/address/list","href":"/api-reference/donor/list-donor-addresses"},{"title":"Set Primary Donor Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/address/{addressId}/set-primary","href":"/api-reference/donor/set-primary-donor-address"},{"title":"Get a Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/contact-method/{contactMethodId}","href":"/api-reference/donor/get-a-donor-contact-method"},{"title":"Update a Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/contact-method/{contactMethodId}","href":"/api-reference/donor/update-a-donor-contact-method"},{"title":"Delete a Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Donor/{id}/contact-method/{contactMethodId}","href":"/api-reference/donor/delete-a-donor-contact-method"},{"title":"Partially Update a Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json patch /api/Donor/{id}/contact-method/{contactMethodId}","href":"/api-reference/donor/partially-update-a-donor-contact-method"},{"title":"Create a Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/contact-method","href":"/api-reference/donor/create-a-donor-contact-method"},{"title":"Set Primary Donor Contact Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/contact-method/{contactMethodId}/set-primary","href":"/api-reference/donor/set-primary-donor-contact-method"},{"title":"List Donor Contact Methods","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/contact-method/list","href":"/api-reference/donor/list-donor-contact-methods"},{"title":"List Donor Email Addresses","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/contact-method/email-addresses","href":"/api-reference/donor/list-donor-email-addresses"},{"title":"List Donor Phone Numbers","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{id}/contact-method/phone-numbers","href":"/api-reference/donor/list-donor-phone-numbers"},{"title":"Create a Donor Email Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/email","href":"/api-reference/donor/create-a-donor-email-address"},{"title":"Update a Donor Email Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/email/{emailId}","href":"/api-reference/donor/update-a-donor-email-address"},{"title":"Partially Update a Donor Email Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json patch /api/Donor/{id}/email/{emailId}","href":"/api-reference/donor/partially-update-a-donor-email-address"},{"title":"Set Primary Donor Email Address","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/email/{emailId}/set-primary","href":"/api-reference/donor/set-primary-donor-email-address"},{"title":"Create a Donor Phone Number","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/phone","href":"/api-reference/donor/create-a-donor-phone-number"},{"title":"Update a Donor Phone Number","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/phone/{phoneId}","href":"/api-reference/donor/update-a-donor-phone-number"},{"title":"Partially Update a Donor Phone Number","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json patch /api/Donor/{id}/phone/{phoneId}","href":"/api-reference/donor/partially-update-a-donor-phone-number"},{"title":"Set Primary Donor Phone Number","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/{id}/phone/{phoneId}/set-primary","href":"/api-reference/donor/set-primary-donor-phone-number"},{"title":"List Donor Custom Fields","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/donor-fields","href":"/api-reference/donor/list-donor-custom-fields"},{"title":"List Donor Custom Field Responses","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/responses","href":"/api-reference/donor/list-donor-custom-field-responses"},{"title":"List Donor Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/gifts","href":"/api-reference/donor/list-donor-gifts"},{"title":"List Donor Recurring Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/recurringgifts","href":"/api-reference/donor/list-donor-recurring-gifts"},{"title":"Create a Donor Activity","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/activity","href":"/api-reference/donor/create-a-donor-activity"},{"title":"List Activities for a Donor","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{id}/activities","href":"/api-reference/donor/list-activities-for-a-donor"},{"title":"List Donor Projects","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/projects","href":"/api-reference/donor/list-donor-projects"},{"title":"Get Donor Campaign Statistics","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/campaign-statistics","href":"/api-reference/donor/get-donor-campaign-statistics"},{"title":"Get Donor Motivation Statistics","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/motivation-statistics","href":"/api-reference/donor/get-donor-motivation-statistics"},{"title":"Get Donor Segment Statistics","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Donor/{donorId}/segment-statistics","href":"/api-reference/donor/get-donor-segment-statistics"},{"title":"Transfer a Donor Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/transfer-gift","href":"/api-reference/donor/transfer-a-donor-gift"},{"title":"Transfer a Donor Recurring Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Donor/transfer-recurring-gift","href":"/api-reference/donor/transfer-a-donor-recurring-gift"},{"title":"Generate Donor Donation Page","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Donor/{donorId}/generate-page","href":"/api-reference/donor/generate-donor-donation-page"}]},{"group":"EmailList","pages":[{"title":"Search Email Lists","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/EmailList/search","href":"/api-reference/emaillist/search-email-lists"}]},{"group":"Gift","pages":[{"title":"List All Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Gift/list","href":"/api-reference/gift/list-all-gifts"},{"title":"Get a Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Gift/{id}","href":"/api-reference/gift/get-a-gift"},{"title":"Delete a Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Gift/{id}","href":"/api-reference/gift/delete-a-gift"},{"title":"Query Gifts","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Gift/query","href":"/api-reference/gift/query-gifts"},{"title":"List Gift Custom Fields","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Gift/{giftId}/gift-fields","href":"/api-reference/gift/list-gift-custom-fields"},{"title":"Refund a Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Gift/{id}/refund","href":"/api-reference/gift/refund-a-gift"},{"title":"Update Gift Notes","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Gift/{giftId}/notes","href":"/api-reference/gift/update-gift-notes"}]},{"group":"MotivationCode","pages":[{"title":"List All Motivation Codes","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/MotivationCode/list","href":"/api-reference/motivationcode/list-all-motivation-codes"},{"title":"Get a Motivation Code","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/MotivationCode/{id}","href":"/api-reference/motivationcode/get-a-motivation-code"},{"title":"Update a Motivation Code","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/MotivationCode/{id}","href":"/api-reference/motivationcode/update-a-motivation-code"},{"title":"Create a Motivation Code","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/MotivationCode","href":"/api-reference/motivationcode/create-a-motivation-code"},{"title":"List All Motivation Code Groups","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/MotivationCode/group/list","href":"/api-reference/motivationcode/list-all-motivation-code-groups"},{"title":"Get a Motivation Code Group","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/MotivationCode/group/{id}","href":"/api-reference/motivationcode/get-a-motivation-code-group"},{"title":"Update a Motivation Code Group","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/MotivationCode/group/{id}","href":"/api-reference/motivationcode/update-a-motivation-code-group"},{"title":"Delete a Motivation Code Group","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/MotivationCode/group/{id}","href":"/api-reference/motivationcode/delete-a-motivation-code-group"},{"title":"Create a Motivation Code Group","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/MotivationCode/group","href":"/api-reference/motivationcode/create-a-motivation-code-group"}]},{"group":"OrgKnowledge","pages":[{"title":"List Knowledge Sources","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/org-knowledge","href":"/api-reference/orgknowledge/list-knowledge-sources"},{"title":"Create a Knowledge Source","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/org-knowledge","href":"/api-reference/orgknowledge/create-a-knowledge-source"},{"title":"Get a Knowledge Source","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/org-knowledge/{id}","href":"/api-reference/orgknowledge/get-a-knowledge-source"},{"title":"Update a Knowledge Source","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/org-knowledge/{id}","href":"/api-reference/orgknowledge/update-a-knowledge-source"},{"title":"Delete a Knowledge Source","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/org-knowledge/{id}","href":"/api-reference/orgknowledge/delete-a-knowledge-source"},{"title":"Reindex a Knowledge Source","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/org-knowledge/{id}/reindex","href":"/api-reference/orgknowledge/reindex-a-knowledge-source"},{"title":"Upload a Knowledge Source File","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/org-knowledge/upload","href":"/api-reference/orgknowledge/upload-a-knowledge-source-file"}]},{"group":"Premium","pages":[{"title":"List All Premiums","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Premium/list","href":"/api-reference/premium/list-all-premiums"},{"title":"Get a Premium","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Premium/{id}","href":"/api-reference/premium/get-a-premium"},{"title":"Update a Premium","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Premium/{id}","href":"/api-reference/premium/update-a-premium"},{"title":"Delete a Premium","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Premium/{id}","href":"/api-reference/premium/delete-a-premium"},{"title":"Create a Premium","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Premium","href":"/api-reference/premium/create-a-premium"},{"title":"Get Premium Deactivation Impact","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Premium/{id}/deactivate","href":"/api-reference/premium/get-premium-deactivation-impact"},{"title":"Deactivate a Premium","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Premium/{id}/deactivate","href":"/api-reference/premium/deactivate-a-premium"}]},{"group":"Project","pages":[{"title":"List All Projects","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/list","href":"/api-reference/project/list-all-projects"},{"title":"Get a Project","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/{projectId}","href":"/api-reference/project/get-a-project"},{"title":"Get a Project by Code","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/code/{projectCode}","href":"/api-reference/project/get-a-project-by-code"},{"title":"Create a Project","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Project","href":"/api-reference/project/create-a-project"},{"title":"Update a Project","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Project/{projectId}/update","href":"/api-reference/project/update-a-project"},{"title":"Delete a Project","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Project/{projectId}/delete","href":"/api-reference/project/delete-a-project"},{"title":"List Project Donors","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/{projectId}/donors","href":"/api-reference/project/list-project-donors"},{"title":"List Project Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/{projectId}/gifts","href":"/api-reference/project/list-project-gifts"},{"title":"Get Project Dependency Count","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/{projectId}/dependency-count","href":"/api-reference/project/get-project-dependency-count"},{"title":"Replace a Project","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Project/replace","href":"/api-reference/project/replace-a-project"},{"title":"Query Projects","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Project/query","href":"/api-reference/project/query-projects"},{"title":"Check if Project Code Exists","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Project/code-exists","href":"/api-reference/project/check-if-project-code-exists"}]},{"group":"Query","pages":[{"title":"List Saved Queries","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Query/list/{queryType}","href":"/api-reference/query/list-saved-queries"},{"title":"Create a Saved Query","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Query","href":"/api-reference/query/create-a-saved-query"},{"title":"Update a Saved Query","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Query/{id}","href":"/api-reference/query/update-a-saved-query"},{"title":"Delete a Saved Query","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Query/{id}","href":"/api-reference/query/delete-a-saved-query"},{"title":"Get Query Parameter Values","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Query/lookup","href":"/api-reference/query/get-query-parameter-values"},{"title":"Parse a Query String","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Query/parse","href":"/api-reference/query/parse-a-query-string"},{"title":"Get Query Options","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Query/options/{queryType}","href":"/api-reference/query/get-query-options"}]},{"group":"Raise","pages":[{"title":"Process a Donation Payment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Raise/give","href":"/api-reference/raise/process-a-donation-payment"},{"title":"Calculate Payment Processing Cost","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Raise/cost/{organizationId}","href":"/api-reference/raise/calculate-payment-processing-cost"},{"title":"Generate Test Payment Method","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Raise/generate-test-payment-method","href":"/api-reference/raise/generate-test-payment-method"},{"title":"Capture a Lead","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Raise/lead","href":"/api-reference/raise/capture-a-lead"}]},{"group":"RecurringGift","pages":[{"title":"List All Recurring Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/RecurringGift/list","href":"/api-reference/recurringgift/list-all-recurring-gifts"},{"title":"Query Recurring Gifts","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/RecurringGift/query","href":"/api-reference/recurringgift/query-recurring-gifts"},{"title":"Get a Recurring Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/RecurringGift/{id}","href":"/api-reference/recurringgift/get-a-recurring-gift"},{"title":"Update a Recurring Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/RecurringGift/{id}","href":"/api-reference/recurringgift/update-a-recurring-gift"},{"title":"List Recurring Gift Activities","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/RecurringGift/{id}/activities","href":"/api-reference/recurringgift/list-recurring-gift-activities"},{"title":"Cancel a Recurring Gift","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/RecurringGift/{id}/cancel","href":"/api-reference/recurringgift/cancel-a-recurring-gift"}]},{"group":"Segment","pages":[{"title":"List All Segments","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/list/{campaignId}","href":"/api-reference/segment/list-all-segments"},{"title":"Check if Segment Code Exists","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/exists","href":"/api-reference/segment/check-if-segment-code-exists"},{"title":"Get a Segment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/{id}","href":"/api-reference/segment/get-a-segment"},{"title":"Update a Segment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Segment/{id}","href":"/api-reference/segment/update-a-segment"},{"title":"Delete a Segment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Segment/{id}","href":"/api-reference/segment/delete-a-segment"},{"title":"Create a Segment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Segment","href":"/api-reference/segment/create-a-segment"},{"title":"Replace a Segment","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Segment/replace","href":"/api-reference/segment/replace-a-segment"},{"title":"List Segment Donors","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/{segmentId}/donors","href":"/api-reference/segment/list-segment-donors"},{"title":"List Segment Gifts","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/{segmentId}/gifts","href":"/api-reference/segment/list-segment-gifts"},{"title":"Get Segment Page Count","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Segment/{segmentId}/page-count","href":"/api-reference/segment/get-segment-page-count"},{"title":"Query Segments","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Segment/query","href":"/api-reference/segment/query-segments"}]},{"group":"Webhook","pages":[{"title":"Get a Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Webhook/{id}","href":"/api-reference/webhook/get-a-webhook"},{"title":"Update a Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Webhook/{id}","href":"/api-reference/webhook/update-a-webhook"},{"title":"Delete a Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Webhook/{id}","href":"/api-reference/webhook/delete-a-webhook"},{"title":"List All Webhooks","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Webhook/list","href":"/api-reference/webhook/list-all-webhooks"},{"title":"Create a Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Webhook","href":"/api-reference/webhook/create-a-webhook"},{"title":"List All Webhook Logs","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Webhook/log/list","href":"/api-reference/webhook/list-all-webhook-logs"},{"title":"List Logs for a Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Webhook/{id}/log/list","href":"/api-reference/webhook/list-logs-for-a-webhook"},{"title":"Get a Webhook Log","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Webhook/{id}/log/{logId}","href":"/api-reference/webhook/get-a-webhook-log"}]},{"group":"Zapier","pages":[{"title":"Subscribe to Zapier Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Zapier/subscribe","href":"/api-reference/zapier/subscribe-to-zapier-webhook"},{"title":"Unsubscribe from Zapier Webhook","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Zapier/unsubscribe/{id}","href":"/api-reference/zapier/unsubscribe-from-zapier-webhook"},{"title":"Test Zapier Connection","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Zapier/test","href":"/api-reference/zapier/test-zapier-connection"},{"title":"Get Zapier Event Samples","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json get /api/Zapier/samples/{eventType}","href":"/api-reference/zapier/get-zapier-event-samples"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/raise"}]}]},{"product":"Virtuous ANALYTICS","pages":[{"title":"Virtuous ANALYTICS","href":"/analytics/data-model-overview"}]},{"product":"Virtuous VOLUNTEER","color":{"light":"#00a3e3","dark":"#00a3e3"},"pages":[{"title":"Virtuous VOLUNTEER","href":"/volunteer/overview"}]},{"product":"Virtuous MOMENTUM","pages":[{"title":"Virtuous MOMENTUM","href":"/momentum/overview"}]}]},"basePath":"","title":"Update a Campaign - Virtuous API Docs","deploymentId":"dpl_7LpC8LvxVNTZSB7twCcVwH4TeFKv","buildId":"dpl_7LpC8LvxVNTZSB7twCcVwH4TeFKv","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-VIWbtsv8.js","snippetPresets-ewmdA2iz.js","utils-DEEnXwTM.js","style-to-object-BY3JEAdk.js","utils-BUI5OFKw.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DczDVjtE.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C1QFmpNs.js","_Uint8Array-0FSGLZoF.js","isObject-FP1Yky1u.js","ApiExamples-DNfazWM6.js","usePlaygroundInputsStore-CU9Zyvn9.js","shallow-DBWJPCN_.js","isEqual-BgubGfZd.js","CodeSnippets-WO5yBq5U.js","CodeSnippet-CATPUnsR.js","getApiPlaygroundDisplay-DVuSDqoz.js","Page-B2HLrc-g.js","DynamicMarkdown-D4bAuXRS.js","SectionHeading-BNNqN1He.js","icon-C7peNQV4.js","MethodPill-Bl2guf_0.js","getPastedJson-B_gFzCQb.js","Check2Icon-BLniSudB.js","axios-CsQoIw0U.js","Markdown-sagBpmAe.js","AssistantPageLink-CgMPWeT2.js","dist-C5tMjMKm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}