using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Webhook/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"eventTypesList\": [],\n \"notificationUrl\": \"<string>\",\n \"securityToken\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"notificationUrl": [
"A valid HTTPS URL is required."
],
"eventTypesList": [
"At least one event type is required."
]
},
"instance": "/api/Webhook/3401"
}
{
"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/Webhook/{id}"
}
using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Webhook/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"eventTypesList\": [],\n \"notificationUrl\": \"<string>\",\n \"securityToken\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"notificationUrl": [
"A valid HTTPS URL is required."
],
"eventTypesList": [
"At least one event type is required."
]
},
"instance": "/api/Webhook/3401"
}
{
"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/Webhook/{id}"
}
Change its notificationUrl, the eventTypesList it listens for, its format, its securityToken, or its status. Set status to pause delivery without deleting the subscription. Returns the updated webhook.
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 webhook.
Body
application/jsontext/jsonapplication/*+json
The webhook request model.
Represents a webhook request.
name
string | null
The name of the webhook.
eventTypesList
enum<integer>[] | null
The events the webhook is subscribed to.
Available options:
10,
11,
12,
20,
21,
22,
30,
31,
32,
40,
41,
42,
50,
51,
52
notificationUrl
string<uri> | null
The URL Raise sends the event payload to. It must accept POST requests over HTTPS.
status
enum<integer>
Whether the webhook is active and receiving events.
Available options:
1,
2
format
enum<integer>
The format to send the payload in.
Available options:
1,
2
securityToken
string | null
The token Raise sends with each delivery so you can verify it came from Raise.
Response
OK
Represents a webhook model.
id
integer<int64>
The unique identifier of the webhook.
name
string | null
read-only
The name of the webhook.
eventTypes
string | null
read-only
The events the webhook is subscribed to.
notificationUrl
string | null
read-only
The URL Raise sends the event payload to.
status
enum<integer>
Whether the webhook is active and receiving events.
Available options:
1,
2
format
enum<integer>
The format the payload is sent in.
Available options:
1,
2
formatDisplay
string | null
The display name of the format.
statusDisplay
string | null
The display name of the status.
securityToken
string | null
read-only
The token Raise sends with each delivery so you can verify it came from Raise.
createdDate
string | null
read-only
The date the webhook was created.
modifiedDate
string | null
read-only
The date the webhook was last modified.
eventTypesList
enum<integer>[] | null
The events the webhook is subscribed to.
Available options:
10,
11,
12,
20,
21,
22,
30,
31,
32,
40,
41,
42,
50,
51,
52
Last modified on October 22, 2026
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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/webhook/update-a-webhook","slug":"/api-reference/webhook/update-a-webhook","pageMetadata":{"title":"Update a Webhook","description":"Updates a webhook subscription.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Webhook/{id}","href":"/api-reference/webhook/update-a-webhook","autogeneratedByOpenApi":true,"hidden":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 webhook subscription.\"\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:[`Change its `,_jsx(_components.code,{children:`notificationUrl`}),`, the `,_jsx(_components.code,{children:`eventTypesList`}),` it listens for, its `,_jsx(_components.code,{children:`format`}),`, its `,_jsx(_components.code,{children:`securityToken`}),`, or its `,_jsx(_components.code,{children:`status`}),`. Set `,_jsx(_components.code,{children:`status`}),` to pause delivery without deleting the subscription. Returns the updated webhook.`]})}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 Webhook","description":"Updates a webhook subscription.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json put /api/Webhook/{id}","href":"/api-reference/webhook/update-a-webhook","autogeneratedByOpenApi":true,"hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhook"],"summary":"Update a Webhook","description":"Updates a webhook subscription.","x-mint":{"content":"Change its `notificationUrl`, the `eventTypesList` it listens for, its `format`, its `securityToken`, or its `status`. Set `status` to pause delivery without deleting the subscription. Returns the updated webhook."},"operationId":"Webhook_UpdateWebhook","parameters":["7910348f-d099-4f87-9800-9a0ce0d5bf8c"],"requestBody":"8a97ca87-0723-43d0-9b14-782c04dbbcb2","responses":{"200":"f480f633-1faa-4600-84ca-610137bd79a0","400":"0ccc389e-9be4-40bc-a8ab-962438d14997","401":"ca2f7707-9a79-46c4-b639-5df2093b2479"},"method":"put","type":"path","servers":["7fc714ab-a0a9-4ef9-b33d-fc58ed75e30b"],"security":["5d71430c-ca7b-441a-b139-8379d412a3ab"],"path":"/api/Webhook/{id}","baseUrlOptions":["https://prod-api.raisedonors.com"],"title":"Update a Webhook","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","dotnet","php","java","ruby","node"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name.oneOf.0":"\u003cstring>","body.notificationUrl.oneOf.0":"\u003cstring>","body.securityToken.oneOf.0":"\u003cstring>"}],"urlDisplay":"full"},"dependencies":{"parameters":{"7910348f-d099-4f87-9800-9a0ce0d5bf8c":{"name":"id","in":"path","description":"The ID of the webhook.","required":true,"schema":{"type":"integer","format":"int64","isRequired":true,"description":"The ID of the webhook.","uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"requestBody":{"description":"The webhook request model.","content":{"application/json":{"schema":{"type":"object","description":"Represents a webhook request.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string\u003curi> | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format to send the payload in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","eventTypesList":[],"notificationUrl":"\u003cstring>","securityToken":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","description":"Represents a webhook request.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string\u003curi> | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format to send the payload in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","eventTypesList":[],"notificationUrl":"\u003cstring>","securityToken":"\u003cstring>"}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","description":"Represents a webhook request.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The URL Raise sends the event payload to. It must accept POST requests over HTTPS.","format":"uri","uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string\u003curi> | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format to send the payload in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","eventTypesList":[],"notificationUrl":"\u003cstring>","securityToken":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f480f633-1faa-4600-84ca-610137bd79a0":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","description":"Represents a webhook model.","properties":{"id":{"type":"integer","description":"The unique identifier of the webhook.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypes":{"oneOf":[{"type":"string","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.0","typeLabel":"string"},{"type":"null","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypes","typeLabel":"string | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format the payload is sent in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"formatDisplay":{"oneOf":[{"type":"string","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"formatDisplay","typeLabel":"string | null"},"statusDisplay":{"oneOf":[{"type":"string","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusDisplay","typeLabel":"string | null"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"},"createdDate":{"oneOf":[{"type":"string","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDate","typeLabel":"string | null"},"modifiedDate":{"oneOf":[{"type":"string","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDate","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]},"examples":{"Example":{"title":"Example","value":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","description":"Represents a webhook model.","properties":{"id":{"type":"integer","description":"The unique identifier of the webhook.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypes":{"oneOf":[{"type":"string","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.0","typeLabel":"string"},{"type":"null","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypes","typeLabel":"string | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format the payload is sent in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"formatDisplay":{"oneOf":[{"type":"string","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"formatDisplay","typeLabel":"string | null"},"statusDisplay":{"oneOf":[{"type":"string","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusDisplay","typeLabel":"string | null"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"},"createdDate":{"oneOf":[{"type":"string","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDate","typeLabel":"string | null"},"modifiedDate":{"oneOf":[{"type":"string","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDate","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]},"examples":{"Example":{"title":"Example","value":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","description":"Represents a webhook model.","properties":{"id":{"type":"integer","description":"The unique identifier of the webhook.","format":"int64","uniqueKey":"id","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"type":"string","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the webhook.","readOnly":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"eventTypes":{"oneOf":[{"type":"string","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.0","typeLabel":"string"},{"type":"null","description":"The events the webhook is subscribed to.","readOnly":true,"uniqueKey":"eventTypes.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypes","typeLabel":"string | null"},"notificationUrl":{"oneOf":[{"type":"string","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL Raise sends the event payload to.","readOnly":true,"uniqueKey":"notificationUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationUrl","typeLabel":"string | null"},"status":{"type":"integer","description":"Whether the webhook is active and receiving events.","format":"int32","enum":[1,2],"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"format":{"type":"integer","description":"The format the payload is sent in.","format":"int32","enum":[1,2],"uniqueKey":"format","typeLabel":"enum\u003cinteger>"},"formatDisplay":{"oneOf":[{"type":"string","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the format.","uniqueKey":"formatDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"formatDisplay","typeLabel":"string | null"},"statusDisplay":{"oneOf":[{"type":"string","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the status.","uniqueKey":"statusDisplay.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusDisplay","typeLabel":"string | null"},"securityToken":{"oneOf":[{"type":"string","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token Raise sends with each delivery so you can verify it came from Raise.","readOnly":true,"uniqueKey":"securityToken.oneOf.1","typeLabel":"null"}],"uniqueKey":"securityToken","typeLabel":"string | null"},"createdDate":{"oneOf":[{"type":"string","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was created.","readOnly":true,"uniqueKey":"createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDate","typeLabel":"string | null"},"modifiedDate":{"oneOf":[{"type":"string","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the webhook was last modified.","readOnly":true,"uniqueKey":"modifiedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"modifiedDate","typeLabel":"string | null"},"eventTypesList":{"oneOf":[{"type":"array","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32","uniqueKey":"eventTypesList.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cinteger>"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.0","typeLabel":"enum\u003cinteger>[]"},{"type":"null","items":{"enum":[10,11,12,20,21,22,30,31,32,40,41,42,50,51,52],"type":"integer","format":"int32"},"description":"The events the webhook is subscribed to.","uniqueKey":"eventTypesList.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTypesList","typeLabel":"enum\u003cinteger>[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]},"examples":{"Example":{"title":"Example","value":{"id":3401,"name":"Gift feed to integration service","eventTypes":"Gift Created, Gift Updated, Gift Deleted","notificationUrl":"https://api.riversidehope.example.org/hooks/raise/gifts","formatDisplay":"JSON","statusDisplay":"Active","securityToken":"whsec_9f2b7c41a8e34d15","createdDate":"2025-09-02T15:20:11Z","modifiedDate":"2025-11-10T09:44:02Z","eventTypesList":[10,11,12]}}},"exampleType":"examples"}},"exampleType":"examples"},"0ccc389e-9be4-40bc-a8ab-962438d14997":{"description":"Bad Request — the webhook 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 webhook 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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"},"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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"}}},"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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"},"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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"}}},"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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"},"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":{"notificationUrl":["A valid HTTPS URL is required."],"eventTypesList":["At least one event type is required."]},"instance":"/api/Webhook/3401"}}},"exampleType":"examples"}},"exampleType":"examples"},"ca2f7707-9a79-46c4-b639-5df2093b2479":{"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/Webhook/{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/Webhook/{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/Webhook/{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/Webhook/{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/Webhook/{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/Webhook/{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 Webhook - Virtuous API Docs","relatedPagesConfig":{"enabled":true,"limit":4,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6b007ec4b61e9fc0c4981907","deploymentId":"69d93d41280a4ed8d7469c6f","questionText":"How do I update a webhook URL?","status":"active","generatedBy":"contextual","path":"api-reference/webhook/update-a-webhook","createdAt":"2026-11-20T17:09:24.376Z","updatedAt":"2026-11-20T17:09:24.376Z","__v":0},{"_id":"6b007ec4b61e9fc0c4981908","deploymentId":"69d93d41280a4ed8d7469c6f","questionText":"Can I change the signing secret?","status":"active","generatedBy":"contextual","path":"api-reference/webhook/update-a-webhook","createdAt":"2026-11-20T17:09:24.376Z","updatedAt":"2026-11-20T17:09:24.376Z","__v":0},{"_id":"6b007ec4b61e9fc0c4981909","deploymentId":"69d93d41280a4ed8d7469c6f","questionText":"How do I pause webhook delivery?","status":"active","generatedBy":"contextual","path":"api-reference/webhook/update-a-webhook","createdAt":"2026-11-20T17:09:24.376Z","updatedAt":"2026-11-20T17:09:24.376Z","__v":0}],"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"}]},"lastModified":"2026-11-20T17:12:47.409Z","gitLastModified":"2026-10-22T13:49:15.000Z","originalFileLocation":"api-reference/webhook/update-a-webhook.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 webhook subscription.\">\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 Webhook - Virtuous API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a webhook subscription.\">\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/webhook/update-a-webhook\">\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=Webhooks\u0026amp;title=Update+a+Webhook\u0026amp;description=Updates+a+webhook+subscription.\u0026amp;theme=483f305e7e8c97e32e572c97\u0026amp;signature=fff09a05ff211f819a04da70aa0332c58df87d4a3682b031fb9b3614a9f64f7c\">\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 Webhook - Virtuous API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a webhook subscription.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://virtuous-7a5d9ba3.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Update+a+Webhook\u0026amp;description=Updates+a+webhook+subscription.\u0026amp;theme=483f305e7e8c97e32e572c97\u0026amp;signature=fff09a05ff211f819a04da70aa0332c58df87d4a3682b031fb9b3614a9f64f7c\">\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/webhook/update-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhook/update-a-webhook.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/webhook/update-a-webhook#webpage\",\"url\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook\",\"name\":\"Update a Webhook\",\"description\":\"Updates a webhook subscription.\",\"dateModified\":\"2026-10-22T13:49:15.000Z\",\"isPartOf\":{\"@id\":\"https://docs.virtuous.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.virtuous.org/api-reference/webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a Webhook\",\"item\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook#apireference\",\"headline\":\"Update a Webhook\",\"name\":\"Update a Webhook\",\"description\":\"Updates a webhook subscription.\",\"url\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.virtuous.org/api-reference/webhook/update-a-webhook#webpage\"},\"dateModified\":\"2026-10-22T13:49:15.000Z\",\"publisher\":{\"@id\":\"https://docs.virtuous.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.virtuous.org#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/webhook/update-a-webhook.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"},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/crm/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/account-and-permissions/get-access-token"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/crm"}]},{"tab":"API Reference (2025)","hidden":true,"groups":[{"group":"Account and Permissions","pages":[{"group":"Authentication Token","pages":[{"title":"Get Access Token","sidebarTitle":"Get Access Token","openapi":"post /Token","description":null,"href":"/api-reference/authentication/get-token"}]},{"group":"Organization","pages":[{"title":"List My Organizations","sidebarTitle":"List My Organizations","openapi":"get /api/Organization","description":null,"href":"/api-reference/organization/gets-organizations-the-user-belongs-to"},{"title":"Get Current Organization","sidebarTitle":"Get Current Organization","openapi":"get /api/Organization/Current","description":null,"href":"/api-reference/organization/gets-the-current-organization-user"},{"title":"Switch Current Organization","sidebarTitle":"Switch Current Organization","openapi":"put /api/Organization/Switch","description":null,"href":"/api-reference/organization/switch-the-current-organization"},{"title":"List My Organizations (v2)","sidebarTitle":"List My Organizations (v2)","openapi":"get /api/v2/Organization","description":"Returns the organizations the authenticated user belongs to, identifying each membership and organization by its public id (a GUID) instead of a sequential integer. Only enabled memberships in enabled organizations are listed. Use organizationUserId with the v2 Switch Current Organization endpoint. The integer ids from the v1 List My Organizations endpoint are not accepted by the v2 endpoints.","href":"/api-reference/organization/list-my-organizations-v2"},{"title":"Get Current Organization (v2)","sidebarTitle":"Get Current Organization (v2)","openapi":"get /api/v2/Organization/Current","description":"Returns the organization the authenticated user is currently working in, with the membership and organization identified by their public ids (GUIDs). Otherwise returns the same fields as the v1 Get Current Organization endpoint, plus the user's organization group assignment.","href":"/api-reference/organization/get-current-organization-v2"},{"title":"Switch Current Organization (v2)","sidebarTitle":"Switch Current Organization (v2)","openapi":"put /api/v2/Organization/Switch","description":"Changes the organization a signed-in user is working in, identifying the target membership by its public id. Send the organizationUserId from the v2 List My Organizations endpoint. Behaves like the v1 Switch Current Organization endpoint: the switch updates the user's saved current organization and does not change the token used to make this call, so request or refresh a token from the /Token endpoint afterward. API keys cannot switch organizations.","href":"/api-reference/organization/switch-current-organization-v2"}]},{"group":"Permission","pages":[{"title":"Get My Permissions","sidebarTitle":"Get My Permissions","openapi":"get /api/Permission","description":null,"href":"/api-reference/organization/gets-this-permissions-for-the-current-user"}]}]},{"group":"Contacts and Individuals","pages":[{"group":"Contacts","root":{"title":"Contacts","sidebarTitle":"Contacts","description":"Contacts in Virtuous are your constituents, givers, prospects, partners -- anyone who has a relationship with your organization.","href":"/api-reference/contacts"},"pages":[{"group":"How to Get Contacts","pages":[{"title":"Get a Contact","sidebarTitle":"Get a Contact","openapi":"get /api/Contact/{contactId}","description":null,"href":"/api-reference/contact/get-contact-by-id"},{"title":"Get a Contact by Reference Source","sidebarTitle":"Get a Contact by Reference Source","openapi":"get /api/Contact/{referenceSource}/{referenceId}","description":null,"href":"/api-reference/contact/get-contact-by-reference-source-and-id"},{"title":"Get a Contact by Reference ID","sidebarTitle":"Get a Contact by Reference ID","openapi":"get /api/Contact/ByReference/{referenceId}","description":"HMAC Auth only.","href":"/api-reference/contact/get-contact-by-reference-id"},{"title":"List Contacts by Tag","sidebarTitle":"List Contacts by Tag","openapi":"get /api/Contact/ByTag/{tagId}","description":null,"href":"/api-reference/contact/get-contacts-by-tag-id"},{"title":"Find a Contact","sidebarTitle":"Find a Contact","openapi":"get /api/Contact/Find","description":"Either email addres *or* reference source and id are required.\r\n Providing both will prioritize the reference source and id.","href":"/api-reference/contact/find-a-contact-by-email-address-or-reference-source-and-id"},{"title":"Search Contacts","sidebarTitle":"Search Contacts","openapi":"post /api/Contact/Search","description":null,"href":"/api-reference/contact/find-all-contacts-that-match-fully-or-partially-the-given-search-parameters"},{"title":"Find Contacts by Proximity","sidebarTitle":"Find Contacts by Proximity","openapi":"post /api/Contact/Proximity","description":null,"href":"/api-reference/contact/find-all-contacts-within-a-given-proximity-of-a-geocoordinate"},{"title":"List Followed Contact Activity","sidebarTitle":"List Followed Contact Activity","openapi":"get /api/Contact/Activity","description":null,"href":"/api-reference/contact/get-the-activity-for-the-contacts-the-user-is-following"},{"title":"List Followed Contacts","sidebarTitle":"List Followed Contacts","openapi":"get /api/Contact/Following","description":null,"href":"/api-reference/contact/get-the-contacts-the-user-is-currently-following"}]},{"group":"How to Create and Update Contacts","pages":[{"title":"Create a Contact","sidebarTitle":"Create a Contact","openapi":"post /api/Contact","description":"Will not check for contact duplicates.","href":"/api-reference/contact/create-a-new-contact"},{"title":"Update a Contact","sidebarTitle":"Update a Contact","openapi":"put /api/Contact/{contactId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object.\r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/contact/update-an-existing-contact"},{"title":"Archive a Contact","sidebarTitle":"Archive a Contact","openapi":"put /api/Contact/Archive/{contactId}","description":null,"href":"/api-reference/contact/archive-a-contact"},{"title":"Unarchive a Contact","sidebarTitle":"Unarchive a Contact","openapi":"put /api/Contact/Unarchive/{contactId}","description":null,"href":"/api-reference/contact/unarchive-a-contact"},{"title":"Toggle Contact Follow Status","sidebarTitle":"Toggle Contact Follow Status","openapi":"put /api/Contact/ToggleFollow/{contactId}","description":null,"href":"/api-reference/contact/update-whether-the-user-is-following-a-contact"}]},{"group":"Working with Collections","root":{"title":"Working with Collections","sidebarTitle":"Working with Collections","description":null,"href":"/api-reference/working-with-collections"},"pages":[{"title":"List Contact Custom Collections","sidebarTitle":"List Contact Custom Collections","openapi":"get /api/Contact/CustomCollections","description":null,"href":"/api-reference/contact/get-collection-for-contacts"},{"title":"Create a Contact Collection","sidebarTitle":"Create a Contact Collection","openapi":"post /api/Contact/{contactId}/Collection/{collectionInstanceId}","description":null,"href":"/api-reference/contact/create-collection-for-a-contact"},{"title":"Update a Contact Collection","sidebarTitle":"Update a Contact Collection","openapi":"put /api/Contact/{contactId}/Collection/{collectionInstanceId}","description":null,"href":"/api-reference/contact/update-collection-for-a-contact"},{"title":"Delete a Contact Collection","sidebarTitle":"Delete a Contact Collection","openapi":"delete /api/Contact/{contactId}/Collection/{collectionInstanceId}","description":null,"href":"/api-reference/contact/delete-collection-for-a-contact"}]},{"group":"Contact Imports","pages":[{"title":"Create a Contact Transaction","sidebarTitle":"Create a Contact Transaction","openapi":"post /api/Contact/Transaction","description":null,"href":"/api-reference/contact/create-a-contact-that-will-be-processed-for-an-import"},{"title":"Create a Contact Import","sidebarTitle":"Create a Contact Import","openapi":"post /api/Contact/Batch","description":null,"href":"/api-reference/contact/create-a-contact-import-that-will-be-processed-for-changes-and-duplicates"}]},{"group":"Configuration","pages":[{"title":"List Contact Prefixes and Titles","sidebarTitle":"List Contact Prefixes and Titles","openapi":"get /api/Contact/Prefixes","description":null,"href":"/api-reference/contact/get-contact-name-prefixestitles"},{"title":"List Contact Types","sidebarTitle":"List Contact Types","openapi":"get /api/Contact/Types","description":"Default types include Household, Organization and Foundation. Configurable via CRM.","href":"/api-reference/contact/get-contact-types"},{"title":"List Contact Custom Fields","sidebarTitle":"List Contact Custom Fields","openapi":"get /api/Contact/CustomFields","description":"Will return all enabled custom fields available for the Contact object.","href":"/api-reference/contact/get-custom-fields-for-contacts"}]},{"group":"Contact Queries","pages":[{"title":"Get Contact Query Options","sidebarTitle":"Get Contact Query Options","openapi":"get /api/Contact/QueryOptions","description":null,"href":"/api-reference/contact/request-query-options-to-build-a-query-for-contacts"},{"title":"Query Contacts (Abbreviated)","sidebarTitle":"Query Contacts (Abbreviated)","openapi":"post /api/Contact/Query","description":null,"href":"/api-reference/contact/request-contacts-with-a-custom-query"},{"title":"Query Contacts (Full)","sidebarTitle":"Query Contacts (Full)","openapi":"post /api/Contact/Query/FullContact","description":"Includes full contact details instead of an abbreviated contact.","href":"/api-reference/contact/request-contacts-with-a-custom-query-1"}]},{"group":"Receipts","pages":[{"title":"List Receipts","sidebarTitle":"List Receipts","openapi":"get /api/Contact/Receipts","description":null,"href":"/api-reference/contact/get-receipts"},{"title":"Get a Receipt","sidebarTitle":"Get a Receipt","openapi":"get /api/Contact/Receipts/{receiptId}","description":null,"href":"/api-reference/contact/get-receipt"}]}]},{"group":"Individuals","root":{"title":"Individuals","sidebarTitle":"Individuals","description":null,"href":"/api-reference/individuals"},"pages":[{"group":"How to Get Individuals","pages":[{"title":"List Individuals for a Contact","sidebarTitle":"List Individuals for a Contact","openapi":"get /api/ContactIndividual/ByContact/{contactId}","description":null,"href":"/api-reference/contact-individual/gets-the-individuals-for-the-specified-contact"},{"title":"Get an Individual","sidebarTitle":"Get an Individual","openapi":"get /api/ContactIndividual/{contactIndividualId}","description":null,"href":"/api-reference/contact-individual/gets-individual-by-id"},{"title":"Find an Individual","sidebarTitle":"Find an Individual","openapi":"get /api/ContactIndividual/Find","description":null,"href":"/api-reference/contact-individual/find-an-individual-by-email-address"},{"title":"Get an Individual Avatar","sidebarTitle":"Get an Individual Avatar","openapi":"get /api/ContactIndividual/{contactIndividualId}/Avatar","description":null,"href":"/api-reference/contact-individual/gets-the-avatar-for-a-specified-contact-individual"}]},{"group":"How to Create and Update","pages":[{"title":"Create an Individual","sidebarTitle":"Create an Individual","openapi":"post /api/ContactIndividual","description":null,"href":"/api-reference/contact-individual/creates-a-new-individual"},{"title":"Upload an Individual Avatar","sidebarTitle":"Upload an Individual Avatar","openapi":"post /api/ContactIndividual/{contactIndividualId}/Avatar","description":null,"href":"/api-reference/contact-individual/uploads-the-avatar-for-a-specified-contact-individual"},{"title":"Update an Individual","sidebarTitle":"Update an Individual","openapi":"put /api/ContactIndividual/{contactIndividualId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/contact-individual/updates-a-contact-individual"},{"title":"Delete an Individual","sidebarTitle":"Delete an Individual","openapi":"delete /api/ContactIndividual/{contactIndividualId}","description":null,"href":"/api-reference/contact-individual/deletes-the-specified-contact-individual"}]},{"group":"Working with Collections","root":{"title":"Working with Collections","sidebarTitle":"Working with Collections","description":null,"href":"/api-reference/working-with-collections"},"pages":[{"title":"List Individual Custom Collections","sidebarTitle":"List Individual Custom Collections","openapi":"get /api/ContactIndividual/CustomCollections","description":null,"href":"/api-reference/contact-individual/get-custom-collections-for-contact-individual-objects"},{"title":"Create an Individual Collection","sidebarTitle":"Create an Individual Collection","openapi":"post /api/ContactIndividual/{contactIndividualId}/Collection/{customCollectionId}","description":null,"href":"/api-reference/contact-individual/create-collection-for-an-individual"},{"title":"Update an Individual Collection","sidebarTitle":"Update an Individual Collection","openapi":"put /api/ContactIndividual/{contactIndividualId}/Collection/{customCollectionId}","description":null,"href":"/api-reference/contact-individual/update-collection-for-an-individual"},{"title":"Delete an Individual Collection","sidebarTitle":"Delete an Individual Collection","openapi":"delete /api/ContactIndividual/{contactIndividualId}/Collection/{customCollectionId}","description":null,"href":"/api-reference/contact-individual/delete-collection-for-an-individual"}]},{"group":"Configuration","pages":[{"title":"List Individual Custom Fields","sidebarTitle":"List Individual Custom Fields","openapi":"get /api/ContactIndividual/CustomFields","description":"Will return all enabled custom fields available for the Contact Indvidual object.","href":"/api-reference/contact-individual/gets-the-custom-fields-for-contact-individuals"}]},{"group":"Individual Queries","pages":[{"title":"Get Individual Query Options","sidebarTitle":"Get Individual Query Options","openapi":"get /api/ContactIndividual/QueryOptions","description":null,"href":"/api-reference/contact-individual/request-query-options-to-build-a-query-for-individuals"},{"title":"Query Individuals","sidebarTitle":"Query Individuals","openapi":"post /api/ContactIndividual/Query","description":null,"href":"/api-reference/contact-individual/request-individuals-with-a-custom-query"}]},{"group":"Email Lists","pages":[{"title":"List Email Lists for an Individual","sidebarTitle":"List Email Lists for an Individual","openapi":"get /api/ContactIndividual/{contactIndividualId}/EmailList","description":null,"href":"/api-reference/contact-individual/get-email-lists-for-an-individual"}]}]},{"group":"Contact Addresses","pages":[{"title":"List Addresses for a Contact","sidebarTitle":"List Addresses for a Contact","openapi":"get /api/ContactAddress/ByContact/{contactId}","description":null,"href":"/api-reference/contact-address/gets-the-contact-addresses-for-the-specified-contact"},{"title":"Get a Contact Address","sidebarTitle":"Get a Contact Address","openapi":"get /api/ContactAddress/{contactAddressId}","description":null,"href":"/api-reference/contact-address/gets-the-specified-contact-address"},{"title":"Create a Contact Address","sidebarTitle":"Create a Contact Address","openapi":"post /api/ContactAddress","description":null,"href":"/api-reference/contact-address/creates-a-new-contact-address"},{"title":"Update a Contact Address","sidebarTitle":"Update a Contact Address","openapi":"put /api/ContactAddress/{contactAddressId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/contact-address/updates-contact-address"},{"title":"Archive a Contact Address","sidebarTitle":"Archive a Contact Address","openapi":"put /api/ContactAddress/Archive/{contactAddressId}","description":null,"href":"/api-reference/contact-address/archive-a-contact-address"},{"title":"Unarchive a Contact Address","sidebarTitle":"Unarchive a Contact Address","openapi":"put /api/ContactAddress/Unarchive/{contactAddressId}","description":null,"href":"/api-reference/contact-address/unarchive-a-contact-address"},{"title":"Delete a Contact Address","sidebarTitle":"Delete a Contact Address","openapi":"delete /api/ContactAddress/{contactAddressId}","description":null,"href":"/api-reference/contact-address/deletes-the-specified-contact-address"}]},{"group":"Contact Methods","root":{"title":"Contact Methods","sidebarTitle":"Contact Methods","description":null,"href":"/api-reference/contact-methods"},"pages":[{"title":"List Contact Method Types","sidebarTitle":"List Contact Method Types","openapi":"get /api/ContactMethod/Types","description":null,"href":"/api-reference/contact-method/gets-the-types-of-contact-methods"},{"title":"List Related Contact Method Types","sidebarTitle":"List Related Contact Method Types","openapi":"get /api/ContactMethod/RelatedTypes","description":null,"href":"/api-reference/contact-method/gets-the-types-of-contact-methods-related-to-the-specified-contact-method-type"},{"title":"Get a Contact Method","sidebarTitle":"Get a Contact Method","openapi":"get /api/ContactMethod/{contactMethodId}","description":null,"href":"/api-reference/contact-method/gets-the-specified-contact-method"},{"title":"Create a Contact Method","sidebarTitle":"Create a Contact Method","openapi":"post /api/ContactMethod","description":null,"href":"/api-reference/contact-method/create-a-new-contact-method-for-the-specified-contact-individual"},{"title":"Update a Contact Method","sidebarTitle":"Update a Contact Method","openapi":"put /api/ContactMethod/{contactMethodId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/contact-method/updates-a-contact-method"},{"title":"Archive a Contact Method","sidebarTitle":"Archive a Contact Method","openapi":"put /api/ContactMethod/Archive/{contactMethodId}","description":null,"href":"/api-reference/contact-method/archive-a-contact-method"},{"title":"Unarchive a Contact Method","sidebarTitle":"Unarchive a Contact Method","openapi":"put /api/ContactMethod/Unarchive/{contactMethodId}","description":null,"href":"/api-reference/contact-method/unarchive-a-contact-method"},{"title":"Delete a Contact Method","sidebarTitle":"Delete a Contact Method","openapi":"delete /api/ContactMethod/{contactMethodId}","description":null,"href":"/api-reference/contact-method/deletes-the-specified-contact-method"}]},{"group":"Contact Notes","pages":[{"title":"List Notes for a Contact","sidebarTitle":"List Notes for a Contact","openapi":"get /api/ContactNote/ByContact/{contactId}","description":null,"href":"/api-reference/contact-note/gets-the-notes-for-the-specified-contact"},{"title":"List Important Notes for a Contact","sidebarTitle":"List Important Notes for a Contact","openapi":"get /api/ContactNote/Important/ByContact/{contactId}","description":null,"href":"/api-reference/contact-note/gets-the-important-notes-for-the-specified-contact"},{"title":"Get a Contact Note","sidebarTitle":"Get a Contact Note","openapi":"get /api/ContactNote/{noteId}","description":null,"href":"/api-reference/contact-note/gets-the-specified-note"},{"title":"Create a Contact Note","sidebarTitle":"Create a Contact Note","openapi":"post /api/ContactNote","description":null,"href":"/api-reference/contact-note/creates-a-new-note-for-the-specified-contact"},{"title":"Create a Note from Email","sidebarTitle":"Create a Note from Email","openapi":"post /api/ContactNote/Email","description":null,"href":"/api-reference/contact-note/posts-the-email-as-a-contact-note"},{"title":"Update a Contact Note","sidebarTitle":"Update a Contact Note","openapi":"put /api/ContactNote/{noteId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/contact-note/updates-a-contact-note"},{"title":"Delete a Contact Note","sidebarTitle":"Delete a Contact Note","openapi":"delete /api/ContactNote/{noteId}","description":null,"href":"/api-reference/contact-note/deletes-the-specified-contact-note"},{"title":"Get Contact Note Query Options","sidebarTitle":"Get Contact Note Query Options","openapi":"get /api/ContactNote/QueryOptions","description":"Returns all possible query options for Contact Notes.","href":"/api-reference/contact-note/contact-note-query-options"},{"title":"Query Contact Notes","sidebarTitle":"Query Contact Notes","openapi":"post /api/ContactNote/Query","description":"To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.ContactNoteController.QueryOptions} endpoint.\r\nIf you're going to consistently query for updated contact notes or new contact notes, don't. Use a webhook instead.\r\nIf requests are timing out, you may be asking for too many items at once. The max take is 1,000.","href":"/api-reference/contact-note/query-contact-notes"},{"title":"List Contact Note Types","sidebarTitle":"List Contact Note Types","openapi":"get /api/ContactNote/Types","description":null,"href":"/api-reference/contact-note/gets-the-types-of-contact-notes"},{"title":"List Contact Note Custom Fields","sidebarTitle":"List Contact Note Custom Fields","openapi":"get /api/ContactNote/CustomFields","description":null,"href":"/api-reference/contact-note/get-custom-fields-for-contact-notes"}]},{"group":"Contact References","pages":[{"title":"Get a Contact Reference","sidebarTitle":"Get a Contact Reference","openapi":"get /api/ContactReference/{id}","description":"Returns the Contact Reference with this numeric record id, if it is visible to the current user. The record id is different from the external referenceId.","href":"/api-reference/contact-reference/get-contact-reference-by-id"},{"title":"Query Contact References","sidebarTitle":"Query Contact References","openapi":"post /api/ContactReference/Query","description":"Returns a paginated list of Contact References visible to the current user. Use Get Contact Reference Query Options to see supported filters and operators. Conditions in each group are combined with AND; groups are combined with OR. Id can be sorted but is not a filter. Sort by Id, Contact Id, Create DateTime UTC, or Last Modified DateTime UTC; an unsupported sortBy value falls back to Id. Archived contacts are excluded from results.","href":"/api-reference/contact-reference/query-contact-references"},{"title":"Get Contact Reference Query Options","sidebarTitle":"Get Contact Reference Query Options","openapi":"get /api/ContactReference/QueryOptions","description":"Returns the parameters and operators available for Contact Reference queries. Use these options when building conditions for Query Contact References. Filter parameters are Contact Id, Contact Individual Id, Reference Source, Reference Id, Create DateTime UTC, and Last Modified DateTime UTC. Id can be sorted but is not a filter. Do not assume an operator is supported unless it appears in this response.","href":"/api-reference/contact-reference/get-contact-reference-query-options"},{"title":"Create a Contact Reference","sidebarTitle":"Create a Contact Reference","openapi":"post /api/ContactReference","description":null,"href":"/api-reference/contact-reference/creates-the-contact-reference"},{"title":"Update a Contact Reference","sidebarTitle":"Update a Contact Reference","openapi":"put /api/ContactReference/{id}","description":"Updates the external referenceId and, optionally, the associated contactIndividualId. The contact and referenceSource cannot be changed. Omit contactIndividualId or set it to null to clear the association.","href":"/api-reference/contact-reference/update-contact-reference"},{"title":"Delete a Contact Reference","sidebarTitle":"Delete a Contact Reference","openapi":"delete /api/ContactReference/{referenceSource}","description":null,"href":"/api-reference/contact-reference/deletes-the-specified-reference-source"}]},{"group":"Tags","pages":[{"title":"List All Tags","sidebarTitle":"List All Tags","openapi":"get /api/Tag","description":null,"href":"/api-reference/tag/gets-the-tags-for-the-current-organization"},{"title":"Search Tags","sidebarTitle":"Search Tags","openapi":"post /api/Tag/Search","description":null,"href":"/api-reference/tag/find-all-tags-that-match-fully-or-partially-the-given-search-parameter"}]},{"group":"Contact Tags","pages":[{"title":"List Tags for a Contact","sidebarTitle":"List Tags for a Contact","openapi":"get /api/ContactTag/ByContact/{contactId}","description":null,"href":"/api-reference/contact-tag/gets-the-tags-for-the-specified-contact"},{"title":"Create a Contact Tag","sidebarTitle":"Create a Contact Tag","openapi":"post /api/ContactTag","description":null,"href":"/api-reference/contact-tag/create-a-new-contact-tag-for-the-specified-contact"},{"title":"Delete a Contact Tag","sidebarTitle":"Delete a Contact Tag","openapi":"delete /api/ContactTag/{contactTagId}","description":null,"href":"/api-reference/contact-tag/deletes-the-specified-contact-tag"}]},{"group":"Organization Groups","pages":[{"title":"List All Organization Groups","sidebarTitle":"List All Organization Groups","openapi":"get /api/OrganizationGroup","description":null,"href":"/api-reference/organization-group/gets-all-the-organization-groups"},{"title":"List Organization Groups for a Contact","sidebarTitle":"List Organization Groups for a Contact","openapi":"get /api/OrganizationGroup/ByContact/{contactId}","description":null,"href":"/api-reference/organization-group/gets-the-organization-group-by-contact-identifier"},{"title":"List Contacts in an Organization Group","sidebarTitle":"List Contacts in an Organization Group","openapi":"get /api/OrganizationGroup/{organizationGroupId}/contacts","description":null,"href":"/api-reference/organization-group/gets-the-organization-group-contacts"},{"title":"Get an Organization Group","sidebarTitle":"Get an Organization Group","openapi":"get /api/OrganizationGroup/{organizationGroupId}","description":null,"href":"/api-reference/organization-group/gets-the-organization-group-with-the-specified-identifier"},{"title":"Add a Contact to an Organization Group","sidebarTitle":"Add a Contact to an Organization Group","openapi":"put /api/OrganizationGroup/{organizationGroupId}/contacts/{contactId}","description":null,"href":"/api-reference/organization-group/assign-a-contact-to-the-organization-group"},{"title":"Remove a Contact from an Organization Group","sidebarTitle":"Remove a Contact from an Organization Group","openapi":"delete /api/OrganizationGroup/{organizationGroupId}/contacts/{contactId}","description":null,"href":"/api-reference/organization-group/unassigns-the-contact-from-the-organization-group"}]},{"group":"Relationships","pages":[{"title":"List Relationships for a Contact","sidebarTitle":"List Relationships for a Contact","openapi":"get /api/Relationship/ByContact/{contactId}","description":null,"href":"/api-reference/relationship/gets-the-relationships-for-the-specified-contact"},{"title":"Create a Relationship","sidebarTitle":"Create a Relationship","openapi":"post /api/Relationship","description":null,"href":"/api-reference/relationship/creates-a-new-relationship"},{"title":"Update a Relationship","sidebarTitle":"Update a Relationship","openapi":"put /api/Relationship/{relationshipId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/relationship/update-an-existing-relationship"},{"title":"Delete a Relationship","sidebarTitle":"Delete a Relationship","openapi":"delete /api/Relationship/{relationshipId}","description":null,"href":"/api-reference/relationship/deletes-the-specified-relationship"},{"title":"List Relationship Types","sidebarTitle":"List Relationship Types","openapi":"get /api/Relationship/Types","description":null,"href":"/api-reference/relationship/gets-the-types-of-relationships"}]},{"group":"Tributes","pages":[{"title":"Get a Tribute","sidebarTitle":"Get a Tribute","openapi":"get /api/Tribute/{tributeId}","description":null,"href":"/api-reference/tribute/get-a-tribute"},{"title":"Search Tributes","sidebarTitle":"Search Tributes","openapi":"get /api/Tribute/Search","description":null,"href":"/api-reference/tribute/searches-for-tributes-that-match-the-given-criteria"},{"title":"Query Tributes","sidebarTitle":"Query Tributes","openapi":"post /api/Tribute/Query","description":"Returns a paginated list of tributes matching the request conditions. Use Is with Tribute Id for an exact id match, or Is with First Name for an exact name match. Retrieve other available parameters and operators from Get Tribute Query Options. Unlike Search Tributes, name matching with Is does not match prefixes.","href":"/api-reference/tribute/query-tributes"},{"title":"Get Tribute Query Options","sidebarTitle":"Get Tribute Query Options","openapi":"get /api/Tribute/QueryOptions","description":"Returns the parameters and operators available for a tribute query. Use each option's parameter and operatorOptions when building conditions for Query Tributes. Tribute Id supports the Is operator for exact matches.","href":"/api-reference/tribute/get-tribute-query-options"},{"title":"Create a Tribute","sidebarTitle":"Create a Tribute","openapi":"post /api/Tribute","description":null,"href":"/api-reference/tribute/creates-a-new-tribute-using-the-specified-post-model"},{"title":"Update a Tribute","sidebarTitle":"Update a Tribute","openapi":"put /api/Tribute/{tributeId}","description":null,"href":"/api-reference/tribute/updates-the-tribute-with-the-specified-identifier-using-the-details-of-the-specified-put-model"}]}]},{"group":"Giving","pages":[{"group":"Gifts","root":{"title":"Gifts","sidebarTitle":"Gifts","description":null,"href":"/api-reference/gifts"},"pages":[{"group":"How to Get Gifts","pages":[{"title":"List Gifts for a Contact","sidebarTitle":"List Gifts for a Contact","openapi":"get /api/Gift/ByContact/{contactId}","description":null,"href":"/api-reference/gift/get-gifts-with-the-specified-contact-identifier"},{"title":"List Gifts by Reference ID","sidebarTitle":"List Gifts by Reference ID","openapi":"get /api/Gift/ByReference/{referenceId}","description":"HMAC Auth only.","href":"/api-reference/gift/get-gifts-by-a-contact-reference-identifier"},{"title":"List Passthrough Gifts for a Contact","sidebarTitle":"List Passthrough Gifts for a Contact","openapi":"get /api/Gift/Passthrough/ByContact/{contactId}","description":null,"href":"/api-reference/gift/get-passthrough-gifts-with-the-specified-contact-identifier"},{"title":"Get a Gift","sidebarTitle":"Get a Gift","openapi":"get /api/Gift/{giftId}","description":null,"href":"/api-reference/gift/get-a-gift-by-the-identifier"},{"title":"Get a Gift by Transaction Source and ID","sidebarTitle":"Get a Gift by Transaction Source and ID","openapi":"get /api/Gift/{transactionSource}/{transactionId}","description":null,"href":"/api-reference/gift/get-a-gift-by-the-transaction-source-and-identifier"}]},{"group":"How to Create and Update Gifts","pages":[{"title":"Create a Gift *not recommended*","sidebarTitle":"Create a Gift *not recommended*","openapi":"post /api/Gift","tag":"Not Recommended","description":"This endpoint creates a gift directly onto a contact record. Using this endpoint assumes\r\nyou know the precise contact the gift is matched to. Virtuous does not support cleaning up data\r\nthat is caused by creating the gifts incorrectly through this endpoint.\r\nPlease use the Gift Transaction endpoint as a better alternative.","href":"/api-reference/gift/create-gift-not-recommended"},{"title":"Create many Gifts *not recommended*","sidebarTitle":"Create many Gifts *not recommended*","openapi":"post /api/Gift/Bulk","tag":"Not Recommended","description":"Bulk create up to 100 Gifts at a time. Please note that\r\nthis endpoint creates gifts directly onto a contact record. Using this endpoint assumes\r\nyou know the precise contact the gift is matched to. Virtuous does not support cleaning up data\r\nthat is caused by creating the gifts incorrectly through this endpoint.\r\nPlease use the Gift Transaction endpoint as a better alternative.","href":"/api-reference/gift/bulk-create-gifts-not-recommended"},{"title":"Create a Reversing Transaction","sidebarTitle":"Create a Reversing Transaction","openapi":"post /api/Gift/ReversingTransaction","description":"Creates a new reversing transaction and uses the gift identifier specified to negate the amount and splits applied.","href":"/api-reference/gift/create-reversing-transaction"},{"title":"Update a Gift","sidebarTitle":"Update a Gift","openapi":"put /api/Gift/{giftId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object.\r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/gift/update-a-gift-with-the-specified-identifier"},{"title":"Bulk Update Gifts","sidebarTitle":"Bulk Update Gifts","openapi":"patch /api/Gift","description":"Use this endpoint anytime more than 1 gift is going to be updated.\r\nPlease note that unlike other update endpoints this endpoint ONLY needs what is being updated (i.e. a patch).\r\nFor example, if you want to update the receipt date on a gift, only send the gift Id and the receipt date.\r\nThis ensures performance is top-notch.","href":"/api-reference/gift/bulk-update-gifts"},{"title":"Delete a Gift","sidebarTitle":"Delete a Gift","openapi":"delete /api/Gift/{giftId}","description":null,"href":"/api-reference/gift/delete-a-gift-with-the-specified-identifier"}]},{"group":"Gift Imports","pages":[{"title":"Create a Gift Transaction","sidebarTitle":"Create a Gift Transaction","openapi":"post /api/v2/Gift/Transaction","description":"HMAC or OAuth Auth valid. This is the recommended way to create a gift.\r\nThis ensures the gift is matched using the Virtuous matching algorithms for Contacts, Recurring gifts, Designations, etc.","href":"/api-reference/gift/create-a-gift-transaction"},{"title":"Bulk Create Gift Transactions","sidebarTitle":"Bulk Create Gift Transactions","openapi":"post /api/v2/Gift/Transactions","description":"HMAC or OAuth Auth valid.","href":"/api-reference/gift/create-a-batch-of-gift-transactions"}]},{"group":"Configuration","pages":[{"title":"List Gift Custom Fields","sidebarTitle":"List Gift Custom Fields","openapi":"get /api/Gift/CustomFields","description":"Will return all enabled custom fields available for the Gift object.","href":"/api-reference/gift/get-the-custom-fields-available-for-gifts"},{"title":"List Non-Cash Gift Types","sidebarTitle":"List Non-Cash Gift Types","openapi":"get /api/Gift/NonCashGiftTypes","description":null,"href":"/api-reference/gift/get-non-cash-gift-types-available"}]},{"group":"Gift Queries","pages":[{"title":"Get Gift Query Options","sidebarTitle":"Get Gift Query Options","openapi":"get /api/Gift/QueryOptions","description":null,"href":"/api-reference/gift/get-gift-query-options"},{"title":"Query Gifts (Abbreviated)","sidebarTitle":"Query Gifts (Abbreviated)","openapi":"post /api/Gift/Query","description":"You can sort by Id, Amount, GiftDate, ReceiptDate and Batch.","href":"/api-reference/gift/get-gifts-matching-the-query-criteria-provided"},{"title":"Query Gifts (Full)","sidebarTitle":"Query Gifts (Full)","openapi":"post /api/Gift/Query/FullGift","description":"Returns the full gift info along with the query. This can cause performance issues.\r\nWe recommend using the Gift Query endpoint for quicker results.\r\nYou can sort by Id, Amount, GiftDate, ReceiptDate and Batch.","href":"/api-reference/gift/get-gifts-matching-the-query-criteria-provided-with-all-gift-info"}]}]},{"group":"Gift Designations","pages":[{"title":"Get Gift Designation Query Options","sidebarTitle":"Get Gift Designation Query Options","openapi":"get /api/GiftDesignation/QueryOptions","description":null,"href":"/api-reference/gift-designation/get-gift-designation-query-options"},{"title":"Query Gift Designations","sidebarTitle":"Query Gift Designations","openapi":"post /api/GiftDesignation/Query","description":"You can sort by Id, Amount, GiftDate, ReceiptDate and Batch.","href":"/api-reference/gift-designation/get-gift-designations-matching-the-query-criteria-provided"}]},{"group":"Gift Asks","pages":[{"title":"List Gift Asks for a Contact","sidebarTitle":"List Gift Asks for a Contact","openapi":"get /api/GiftAsk/ByContact/{contactId}","description":null,"href":"/api-reference/gift-ask/gets-the-gift-asks-for-the-specified-contact"},{"title":"List Gifts for a Gift Ask","sidebarTitle":"List Gifts for a Gift Ask","openapi":"get /api/GiftAsk/{giftAskId}/Gifts","description":null,"href":"/api-reference/gift-ask/gets-the-gifts-applied-to-the-specified-gift-ask"},{"title":"Get a Gift Ask","sidebarTitle":"Get a Gift Ask","openapi":"get /api/GiftAsk/{giftAskId}","description":null,"href":"/api-reference/gift-ask/gets-the-specified-gift-ask"},{"title":"Create a Gift Ask","sidebarTitle":"Create a Gift Ask","openapi":"post /api/GiftAsk","description":null,"href":"/api-reference/gift-ask/creates-a-new-gift-ask"},{"title":"Update a Gift Ask","sidebarTitle":"Update a Gift Ask","openapi":"put /api/GiftAsk/{giftAskId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/gift-ask/updates-a-gift-ask"},{"title":"List Gift Ask Custom Fields","sidebarTitle":"List Gift Ask Custom Fields","openapi":"get /api/GiftAsk/CustomFields","description":"Will return all enabled custom fields available for the Gift Ask object.","href":"/api-reference/gift-ask/get-the-custom-fields-available-for-gift-asks"},{"title":"Get Gift Ask Query Options","sidebarTitle":"Get Gift Ask Query Options","openapi":"get /api/GiftAsk/QueryOptions","description":null,"href":"/api-reference/gift-ask/request-query-options-to-build-a-query-for-gift-asks"},{"title":"Query Gift Asks","sidebarTitle":"Query Gift Asks","openapi":"post /api/GiftAsk/Query","description":null,"href":"/api-reference/gift-ask/request-gift-asks-with-a-custom-query"}]},{"group":"Planned Gifts","pages":[{"title":"List Planned Gifts for a Contact","sidebarTitle":"List Planned Gifts for a Contact","openapi":"get /api/PlannedGift/ByContact/{contactId}","description":null,"href":"/api-reference/planned-gift/gets-the-planned-gifts-for-the-specified-contact"},{"title":"Get a Planned Gift","sidebarTitle":"Get a Planned Gift","openapi":"get /api/PlannedGift/{plannedGiftId}","description":null,"href":"/api-reference/planned-gift/gets-the-specified-planned-gift"},{"title":"List Gifts for a Planned Gift","sidebarTitle":"List Gifts for a Planned Gift","openapi":"get /api/PlannedGift/{plannedGiftId}/Gifts","description":null,"href":"/api-reference/planned-gift/gets-the-gifts-applied-to-the-specified-planned-gift"},{"title":"Create a Planned Gift","sidebarTitle":"Create a Planned Gift","openapi":"post /api/PlannedGift","description":null,"href":"/api-reference/planned-gift/created-a-new-planned-gift"},{"title":"Update a Planned Gift","sidebarTitle":"Update a Planned Gift","openapi":"put /api/PlannedGift/{plannedGiftId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/planned-gift/updates-a-planned-gift"},{"title":"List Planned Gift Custom Fields","sidebarTitle":"List Planned Gift Custom Fields","openapi":"get /api/PlannedGift/CustomFields","description":"Will return all enabled custom fields available for the Planned Gift object.","href":"/api-reference/planned-gift/get-the-custom-fields-available-for-planned-gifts"},{"title":"Get Planned Gift Query Options","sidebarTitle":"Get Planned Gift Query Options","openapi":"get /api/PlannedGift/QueryOptions","description":null,"href":"/api-reference/planned-gift/request-query-options-to-build-a-query-for-planned-gifts"},{"title":"Query Planned Gifts","sidebarTitle":"Query Planned Gifts","openapi":"post /api/PlannedGift/Query","description":null,"href":"/api-reference/planned-gift/request-planned-gifts-with-a-custom-query"}]},{"group":"Pledges","root":{"title":"Pledges","sidebarTitle":"Pledges","description":"A pledge represents a commitment from a donor to give a specific sum of money over a set period of time.","href":"/api-reference/pledges"},"pages":[{"title":"List Pledges for a Contact","sidebarTitle":"List Pledges for a Contact","openapi":"get /api/v2/Pledge/ByContact/{contactId}","description":null,"href":"/api-reference/pledge/gets-the-pledges-for-the-specified-contact"},{"title":"Get a Pledge","sidebarTitle":"Get a Pledge","openapi":"get /api/v2/Pledge/{pledgeId}","description":null,"href":"/api-reference/pledge/gets-the-specified-pledge"},{"title":"Create a Pledge","sidebarTitle":"Create a Pledge","openapi":"post /api/PledgeV2","description":null,"href":"/api-reference/pledge/create-a-new-pledge-for-a-contact"},{"title":"Update a Pledge","sidebarTitle":"Update a Pledge","openapi":"put /api/v2/Pledge/{pledgeId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/pledge/update-an-existing-pledge"},{"title":"Write Off a Pledge","sidebarTitle":"Write Off a Pledge","openapi":"put /api/v2/Pledge/WriteOff/{pledgeId}","description":null,"href":"/api-reference/pledge/write-off-the-specified-pledge"},{"title":"List Pledge Custom Fields","sidebarTitle":"List Pledge Custom Fields","openapi":"get /api/v2/Pledge/CustomFields","description":"Will return all enabled custom fields available for the Pledge object.","href":"/api-reference/pledge/get-the-custom-fields-available-for-pledges"},{"title":"Get Pledge Query Options","sidebarTitle":"Get Pledge Query Options","openapi":"get /api/v2/Pledge/QueryOptions","description":null,"href":"/api-reference/pledge/request-query-options-to-build-a-query-for-pledges"},{"title":"Query Pledges","sidebarTitle":"Query Pledges","openapi":"post /api/v2/Pledge/Query","description":null,"href":"/api-reference/pledge/request-pledges-with-a-custom-query"}]},{"group":"Premiums","pages":[{"title":"Get a Premium","sidebarTitle":"Get a Premium","openapi":"get /api/Premium/{premiumId}","description":null,"href":"/api-reference/premium/get-premium-by-id"},{"title":"Get a Premium by Code","sidebarTitle":"Get a Premium by Code","openapi":"get /api/Premium/Code/{premiumCode}","description":null,"href":"/api-reference/premium/get-premium-by-code"},{"title":"Search Premiums","sidebarTitle":"Search Premiums","openapi":"post /api/Premium/Search","description":null,"href":"/api-reference/premium/find-premiums-using-the-specified-parameters"},{"title":"Create a Premium","sidebarTitle":"Create a Premium","openapi":"post /api/Premium","description":null,"href":"/api-reference/premium/create-a-new-premium"},{"title":"Update a Premium","sidebarTitle":"Update a Premium","openapi":"put /api/Premium/{premiumId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/premium/update-an-existing-premium"},{"title":"Increment Premium Inventory","sidebarTitle":"Increment Premium Inventory","openapi":"put /api/Premium/Increment/{premiumId}","description":"The incrementor defaults to 1 and MUST be a positive number. If you need to decrement, use the Decrement Premium endpoint.","href":"/api-reference/premium/increment-the-inventory-count"},{"title":"Decrement Premium Inventory","sidebarTitle":"Decrement Premium Inventory","openapi":"put /api/Premium/Decrement/{premiumId}","description":"The decrementor defaults to -1 and MUST be a negative number. If you need to increment, use the Increment Premium endpoint.","href":"/api-reference/premium/decrement-the-inventory-count"},{"title":"List Premium Custom Fields","sidebarTitle":"List Premium Custom Fields","openapi":"get /api/Premium/CustomFields","description":"Will return all enabled custom fields available for the Premium object.","href":"/api-reference/premium/get-the-custom-fields-available-for-premiums"},{"title":"Query Premiums","sidebarTitle":"Query Premiums","openapi":"post /api/Premium/Query","description":null,"href":"/api-reference/premium/query-premiums"},{"title":"Get Premium Query Options","sidebarTitle":"Get Premium Query Options","openapi":"get /api/Premium/QueryOptions","description":null,"href":"/api-reference/premium/get-premium-query-options"}]},{"group":"Recurring Gifts","root":{"title":"Recurring Gifts","sidebarTitle":"Recurring Gifts","description":null,"href":"/api-reference/recurring-gifts"},"pages":[{"title":"List Recurring Gifts for a Contact","sidebarTitle":"List Recurring Gifts for a Contact","openapi":"get /api/RecurringGift/ByContact/{contactId}","description":null,"href":"/api-reference/recurring-gift/gets-the-recurring-gifts-for-the-specified-contact"},{"title":"Get a Recurring Gift","sidebarTitle":"Get a Recurring Gift","openapi":"get /api/RecurringGift/{recurringGiftId}","description":null,"href":"/api-reference/recurring-gift/gets-the-specified-recurring-gift"},{"title":"Create a Recurring Gift","sidebarTitle":"Create a Recurring Gift","openapi":"post /api/RecurringGift","description":null,"href":"/api-reference/recurring-gift/created-a-new-recurring-gift"},{"title":"Update a Recurring Gift","sidebarTitle":"Update a Recurring Gift","openapi":"put /api/RecurringGift/{recurringGiftId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/recurring-gift/update-an-existing-recurring-gift"},{"title":"Cancel a Recurring Gift","sidebarTitle":"Cancel a Recurring Gift","openapi":"put /api/RecurringGift/Cancel/{recurringGiftId}","description":null,"href":"/api-reference/recurring-gift/cancels-the-specified-recurring-gift"},{"title":"List Recurring Gift Custom Fields","sidebarTitle":"List Recurring Gift Custom Fields","openapi":"get /api/RecurringGift/CustomFields","description":"Will return all enabled custom fields available for the Recurring Gift object.","href":"/api-reference/recurring-gift/get-the-custom-fields-available-for-recurring-gifts"},{"title":"Get Recurring Gift Query Options","sidebarTitle":"Get Recurring Gift Query Options","openapi":"get /api/RecurringGift/QueryOptions","description":null,"href":"/api-reference/recurring-gift/request-query-options-to-build-a-query-for-recurring-gifts"},{"title":"Query Recurring Gifts","sidebarTitle":"Query Recurring Gifts","openapi":"post /api/RecurringGift/Query","description":null,"href":"/api-reference/recurring-gift/request-recurring-gifts-with-a-custom-query"}]},{"group":"Recurring Gift Payments","root":{"title":"Recurring Gift Payments","sidebarTitle":"Recurring Gift Payments","description":null,"href":"/api-reference/recurring-gift-payments"},"pages":[{"title":"List Payments for a Recurring Gift","sidebarTitle":"List Payments for a Recurring Gift","openapi":"get /api/RecurringGiftPayment/{recurringGiftId}","description":null,"href":"/api-reference/recurring-gift/gets-recurring-gift-payments-for-the-specified-recurring-gift-identifier"}]}]},{"group":"Campaigns","pages":[{"group":"Campaigns","root":{"title":"Campaigns","sidebarTitle":"Campaigns","description":null,"href":"/api-reference/campaigns"},"pages":[{"title":"Get a Campaign","sidebarTitle":"Get a Campaign","openapi":"get /api/Campaign/{campaignId}","description":null,"href":"/api-reference/campaign/get-by-id"},{"title":"Create a Campaign","sidebarTitle":"Create a Campaign","openapi":"post /api/Campaign","description":"Creates a campaign.","href":"/api-reference/campaign/create-campaign"},{"title":"Update a Campaign","sidebarTitle":"Update a Campaign","openapi":"put /api/Campaign/{campaignId}","description":null,"href":"/api-reference/campaign/update-campaign"},{"title":"List Campaign Steps","sidebarTitle":"List Campaign Steps","openapi":"get /api/Campaign/GetStepsByCampaignId/{campaignId}","description":null,"href":"/api-reference/campaign/gets-campaign-steps"},{"title":"Get Campaign Query Options","sidebarTitle":"Get Campaign Query Options","openapi":"get /api/Campaign/QueryOptions","description":null,"href":"/api-reference/campaign/campaign-query-options"},{"title":"Query Campaigns","description":"Searches campaigns with the query builder and returns a paginated list of matches. Deprecated and superseded by `POST /api/Query/campaign/execute`. This endpoint keeps working and returns a `Deprecation` response header.","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Campaign/query","href":"/api-reference/campaign/query-campaigns"}]},{"group":"Communications","root":{"title":"Communications","sidebarTitle":"Communications","description":null,"href":"/api-reference/communications"},"pages":[{"title":"List Communications for a Campaign","sidebarTitle":"List Communications for a Campaign","openapi":"get /api/Communication/ByCampaign/{campaignId}","description":null,"href":"/api-reference/communication/get-by-campaign-id"},{"title":"Get a Communication","sidebarTitle":"Get a Communication","openapi":"get /api/Communication/{communicationId}","description":null,"href":"/api-reference/communication/get-by-id"},{"title":"List Channel Types","sidebarTitle":"List Channel Types","openapi":"get /api/Communication/ChannelTypes","description":null,"href":"/api-reference/communication/get-channel-types"},{"title":"List Communication Types","sidebarTitle":"List Communication Types","openapi":"get /api/Communication/CommunicationTypes","description":null,"href":"/api-reference/communication/get-communication-types"},{"title":"Create a Communication","sidebarTitle":"Create a Communication","openapi":"post /api/Communication","description":null,"href":"/api-reference/communication/create-communication"},{"title":"Query Communications","sidebarTitle":"Query Communications","openapi":"post /api/Communication/Query","description":null,"href":"/api-reference/communication/query-communications"},{"title":"Get Communication Query Options","sidebarTitle":"Get Communication Query Options","openapi":"get /api/Communication/QueryOptions","description":null,"href":"/api-reference/communication/communication-query-options"}]},{"group":"Segments","root":{"title":"Segments","sidebarTitle":"Segments","description":null,"href":"/api-reference/segments"},"pages":[{"title":"List Segments for a Contact","sidebarTitle":"List Segments for a Contact","openapi":"get /api/Segment/ByContact/{contactId}","description":null,"href":"/api-reference/segment/get-segments-by-contact"},{"title":"Get a Segment","sidebarTitle":"Get a Segment","openapi":"get /api/Segment/{segmentId}","description":null,"href":"/api-reference/segment/get-the-segment-by-id"},{"title":"Get a Segment by Code","sidebarTitle":"Get a Segment by Code","openapi":"get /api/Segment/Code/{segmentCode}","description":null,"href":"/api-reference/segment/get-the-segment-by-code"},{"title":"Search Segments","sidebarTitle":"Search Segments","openapi":"post /api/Segment/Search","description":null,"href":"/api-reference/segment/find-segments-using-the-specified-parameters"},{"title":"Create a Segment","sidebarTitle":"Create a Segment","openapi":"post /api/Segment","description":null,"href":"/api-reference/segment/create-a-new-segment"},{"title":"Update a Segment","sidebarTitle":"Update a Segment","openapi":"put /api/Segment/{segmentId}","description":null,"href":"/api-reference/segment/update-an-existing-segment"}]}]},{"group":"Projects","pages":[{"group":"How to Get Projects","pages":[{"title":"Get a Project","sidebarTitle":"Get a Project","openapi":"get /api/Project/{projectId}","description":null,"href":"/api-reference/project/get-project-by-id"},{"title":"Get a Project by Code","sidebarTitle":"Get a Project by Code","openapi":"get /api/Project/Code/{projectCode}","description":null,"href":"/api-reference/project/get-project-by-code"},{"title":"Search Projects","sidebarTitle":"Search Projects","openapi":"post /api/Project/Search","description":null,"href":"/api-reference/project/find-projects"}]},{"group":"How to Create and Update Projects","pages":[{"title":"Create a Project","sidebarTitle":"Create a Project","openapi":"post /api/Project","description":null,"href":"/api-reference/project/create-project"},{"title":"Update a Project","sidebarTitle":"Update a Project","openapi":"put /api/Project/{projectId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/project/update-project"},{"title":"Bulk Update Projects","sidebarTitle":"Bulk Update Projects","openapi":"patch /api/Project","description":"Use this endpoint anytime more than 1 project is going to be updated. \r\nPlease note that unlike other update endpoints this endpoint ONLY needs what is being updated (i.e. a patch).\r\nFor example, if you want to update the name on a project, only send the projectId and the name. \r\nThis ensures performance is top-notch.","href":"/api-reference/project/bulk-update"},{"title":"Temporarily Change Project Inventory Status","sidebarTitle":"Temporarily Change Project Inventory Status","openapi":"put /api/Project/{projectId}/Status","description":null,"href":"/api-reference/project/temporarily-change-project-inventory-status"},{"title":"Update Project Balance","sidebarTitle":"Update Project Balance","openapi":"put /api/Project/{projectId}/Balance","description":null,"href":"/api-reference/project/update-project-balance"}]},{"group":"Configuration","pages":[{"title":"List Project Custom Fields","sidebarTitle":"List Project Custom Fields","openapi":"get /api/Project/CustomFields","description":"Will return all enabled custom fields available for the Project object.","href":"/api-reference/project/get-the-custom-fields-available-for-projects"},{"title":"List Project Types","sidebarTitle":"List Project Types","openapi":"get /api/Project/Types","description":null,"href":"/api-reference/project/get-project-types"}]},{"group":"Project Queries","pages":[{"title":"Get Project Query Options","sidebarTitle":"Get Project Query Options","openapi":"get /api/Project/QueryOptions","description":"Returns all possible query options for Projects.","href":"/api-reference/project/project-query-options"},{"title":"Query Projects","description":"Searches projects with the query builder and returns a paginated list of matches. Deprecated and superseded by `POST /api/Query/project/execute`. This endpoint keeps working and returns a `Deprecation` response header.","deprecated":true,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Project/query","href":"/api-reference/project/query-projects"}]},{"group":"Project Expenses","pages":[{"title":"List Project Expenses","sidebarTitle":"List Project Expenses","openapi":"get /api/ProjectExpense","description":null,"href":"/api-reference/project-expense/get-all-project-expenses-that-match-the-specified-parameters"},{"title":"Get a Project Expense","sidebarTitle":"Get a Project Expense","openapi":"get /api/ProjectExpense/{projectExpenseId}","description":null,"href":"/api-reference/project-expense/get-by-id"},{"title":"Create a Project Expense","sidebarTitle":"Create a Project Expense","openapi":"post /api/ProjectExpense","description":null,"href":"/api-reference/project-expense/create-project-expense"},{"title":"Bulk Create Project Expenses","sidebarTitle":"Bulk Create Project Expenses","openapi":"post /api/ProjectExpense/Batch","description":null,"href":"/api-reference/project-expense/create-multiple-project-expenses"},{"title":"Update a Project Expense","sidebarTitle":"Update a Project Expense","openapi":"put /api/ProjectExpense/{projectExpenseId}","description":null,"href":"/api-reference/project-expense/update-project-expense"}]},{"group":"Project Notes","pages":[{"title":"List Notes for a Project","sidebarTitle":"List Notes for a Project","openapi":"get /api/ProjectNote/ByProject/{projectId}","description":null,"href":"/api-reference/project-note/gets-the-notes-for-the-specified-project"},{"title":"Get a Project Note","sidebarTitle":"Get a Project Note","openapi":"get /api/ProjectNote/{noteId}","description":null,"href":"/api-reference/project-note/gets-the-specified-note"},{"title":"Create a Project Note","sidebarTitle":"Create a Project Note","openapi":"post /api/ProjectNote","description":null,"href":"/api-reference/project-note/creates-a-new-note-for-the-specified-project"},{"title":"Update a Project Note","sidebarTitle":"Update a Project Note","openapi":"put /api/ProjectNote/{noteId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/project-note/updates-a-project-note"},{"title":"Delete a Project Note","sidebarTitle":"Delete a Project Note","openapi":"delete /api/ProjectNote/{noteId}","description":null,"href":"/api-reference/project-note/deletes-the-specified-project-note"},{"title":"List Project Note Types","sidebarTitle":"List Project Note Types","openapi":"get /api/ProjectNote/Types","description":null,"href":"/api-reference/project-note/gets-the-types-of-contact-methods"}]},{"group":"Project Roles","pages":[{"title":"List Project Roles for a Contact","sidebarTitle":"List Project Roles for a Contact","openapi":"get /api/ProjectRole/ByContact/{contactId}","description":null,"href":"/api-reference/project-role/gets-project-roles-by-contact"},{"title":"List Project Roles for a Project","sidebarTitle":"List Project Roles for a Project","openapi":"get /api/ProjectRole/ByProject/{projectId}","description":null,"href":"/api-reference/project-role/gets-project-roles-by-project"},{"title":"Get a Project Role","sidebarTitle":"Get a Project Role","openapi":"get /api/ProjectRole/{projectRoleId}","description":null,"href":"/api-reference/project-role/gets-the-project-role"},{"title":"Create a Project Role","sidebarTitle":"Create a Project Role","openapi":"post /api/ProjectRole","description":null,"href":"/api-reference/project-role/creates-a-new-project-role"},{"title":"Update a Project Role","sidebarTitle":"Update a Project Role","openapi":"put /api/ProjectRole/{projectRoleId}","description":null,"href":"/api-reference/project-role/updates-project-role"},{"title":"Delete a Project Role","sidebarTitle":"Delete a Project Role","openapi":"delete /api/ProjectRole/{projectRoleId}","description":null,"href":"/api-reference/project-role/deletes-the-project-role"},{"title":"List Project Role Types","sidebarTitle":"List Project Role Types","openapi":"get /api/ProjectRole/Types","description":null,"href":"/api-reference/project-role/gets-the-project-role-types"}]}]},{"group":"Events","pages":[{"group":"Event","pages":[{"title":"List All Events","sidebarTitle":"List All Events","openapi":"get /api/Event","description":null,"href":"/api-reference/event/gets-all-events-for-the-current-organization"},{"title":"Get an Event","sidebarTitle":"Get an Event","openapi":"get /api/Event/{eventId}","description":null,"href":"/api-reference/event/gets-the-event-with-the-specified-identifier"},{"title":"Find an Event","sidebarTitle":"Find an Event","openapi":"get /api/Event/Search","description":null,"href":"/api-reference/event/searches-for-events-that-match-the-specified-filter"},{"title":"Create an Event","sidebarTitle":"Create an Event","openapi":"post /api/Event","description":null,"href":"/api-reference/event/creates-a-new-event-using-the-specified-post-model"},{"title":"Update an Event","sidebarTitle":"Update an Event","openapi":"put /api/Event/{eventId}","description":null,"href":"/api-reference/event/updates-the-event-with-the-specified-identifier-using-the-details-of-the-specified-put-model"},{"title":"Delete an Event","sidebarTitle":"Delete an Event","openapi":"delete /api/Event/{eventId}","description":null,"href":"/api-reference/event/deletes-the-event-with-the-specified-identifier"},{"title":"List Event Types","sidebarTitle":"List Event Types","openapi":"get /api/Event/Types","description":null,"href":"/api-reference/event/gets-the-suggested-event-types"},{"title":"List Event Custom Fields","sidebarTitle":"List Event Custom Fields","openapi":"get /api/Event/CustomFields","description":null,"href":"/api-reference/event/gets-the-custom-fields-for-events"},{"title":"Get Event Query Options","sidebarTitle":"Get Event Query Options","openapi":"get /api/Event/QueryOptions","description":null,"href":"/api-reference/event/request-query-options-to-build-a-query-for-events"},{"title":"Query Events","sidebarTitle":"Query Events","openapi":"post /api/Event/Query","description":null,"href":"/api-reference/event/request-events-with-a-custom-query"}]},{"group":"Event Attendees","pages":[{"title":"List Event Attendees","sidebarTitle":"List Event Attendees","openapi":"get /api/Event/{eventId}/Attendees","description":null,"href":"/api-reference/event/get-all-event-attendees-for-the-specified-event"},{"title":"Get an Event Attendee","sidebarTitle":"Get an Event Attendee","openapi":"get /api/Event/{eventId}/Attendees/{eventAttendeeId}","description":null,"href":"/api-reference/event/get-the-specified-event-attendee"},{"title":"Create an Event Attendee","sidebarTitle":"Create an Event Attendee","openapi":"post /api/Event/{eventId}/Attendees","description":null,"href":"/api-reference/event/create-a-new-event-attendee"},{"title":"Update an Event Attendee","sidebarTitle":"Update an Event Attendee","openapi":"put /api/Event/{eventId}/Attendees/{eventAttendeeId}","description":null,"href":"/api-reference/event/update-the-event-attendee"},{"title":"Delete an Event Attendee","sidebarTitle":"Delete an Event Attendee","openapi":"delete /api/Event/{eventId}/Attendees/{eventAttendeeId}","description":null,"href":"/api-reference/event/delete-the-event-attendee"},{"title":"List Event Attendee Custom Fields","sidebarTitle":"List Event Attendee Custom Fields","openapi":"get /api/EventAttendee/CustomFields","description":null,"href":"/api-reference/event-attendee/get-the-custom-fields-for-event-attendees"},{"title":"Get Event Attendee Query Options","sidebarTitle":"Get Event Attendee Query Options","openapi":"get /api/EventAttendee/QueryOptions","description":null,"href":"/api-reference/event-attendee/request-query-options-to-build-a-query-for-event-attendees"},{"title":"Query Event Attendees","sidebarTitle":"Query Event Attendees","openapi":"post /api/EventAttendee/Query","description":null,"href":"/api-reference/event-attendee/request-event-attendees-with-a-custom-query"}]},{"group":"Event Contacts","pages":[{"title":"List Event Contacts","sidebarTitle":"List Event Contacts","openapi":"get /api/Event/{eventId}/Contacts","description":null,"href":"/api-reference/event/gets-all-event-contacts-for-the-specified-event"},{"title":"Get an Event Contact","sidebarTitle":"Get an Event Contact","openapi":"get /api/Event/{eventId}/Contacts/{eventContactId}","description":null,"href":"/api-reference/event/gets-the-event-contact-with-the-specified-identifier"},{"title":"Create an Event Contact","sidebarTitle":"Create an Event Contact","openapi":"post /api/Event/{eventId}/Contacts","description":null,"href":"/api-reference/event/creates-the-event-contact-for-the-event-with-the-specified-identifier-using-the-specified-post-model"},{"title":"Delete an Event Contact","sidebarTitle":"Delete an Event Contact","openapi":"delete /api/Event/{eventId}/Contacts/{eventContactId}","description":null,"href":"/api-reference/event/deletes-the-event-contact-with-the-specified-identifier"}]}]},{"group":"Grants","pages":[{"group":"Grants","pages":[{"title":"List Grants for a Contact","sidebarTitle":"List Grants for a Contact","openapi":"get /api/Grant/ByContact/{contactId}","description":null,"href":"/api-reference/grant/gets-a-list-of-grants-by-a-contact-identifier"},{"title":"Get a Grant","sidebarTitle":"Get a Grant","openapi":"get /api/Grant/{grantId}","description":null,"href":"/api-reference/grant/gets-the-grant-by-the-grant-identifier"},{"title":"Get a Grant by Reference ID","sidebarTitle":"Get a Grant by Reference ID","openapi":"get /api/Grant/ByReference/{referenceId}","description":null,"href":"/api-reference/grant/gets-the-grant-by-the-reference-identifier"},{"title":"List Gifts for a Grant","sidebarTitle":"List Gifts for a Grant","openapi":"get /api/Grant/{grantId}/Gifts","description":null,"href":"/api-reference/grant/gets-the-gifts-applied-to-the-specified-grant"},{"title":"Create a Grant","sidebarTitle":"Create a Grant","openapi":"post /api/Grant","description":null,"href":"/api-reference/grant/creates-a-new-grant"},{"title":"Update a Grant","sidebarTitle":"Update a Grant","openapi":"put /api/Grant/{grantId}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/grant/updates-a-grant"},{"title":"Delete a Grant","sidebarTitle":"Delete a Grant","openapi":"delete /api/Grant/{grantId}","description":null,"href":"/api-reference/grant/deletes-a-grant"},{"title":"List Grant Custom Fields","sidebarTitle":"List Grant Custom Fields","openapi":"get /api/Grant/CustomFields","description":"Will return all enabled custom fields available for the Grant object.","href":"/api-reference/grant/get-the-custom-fields-available-for-grants"},{"title":"Get Grant Query Options","sidebarTitle":"Get Grant Query Options","openapi":"get /api/Grant/QueryOptions","description":null,"href":"/api-reference/grant/request-query-options-to-build-a-query-for-grants"},{"title":"Query Grants","sidebarTitle":"Query Grants","openapi":"post /api/Grant/Query","description":null,"href":"/api-reference/grant/request-grants-with-a-custom-query"}]}]},{"group":"Volunteering","pages":[{"group":"Volunteer Opportunity","pages":[{"title":"List All Volunteer Opportunities","sidebarTitle":"List All Volunteer Opportunities","openapi":"get /api/VolunteerOpportunity","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-volunteer-opportunities"},{"title":"Get a Volunteer Opportunity","sidebarTitle":"Get a Volunteer Opportunity","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-specified-volunteer-opportunity-with-the-specified-identifier"},{"title":"Create a Volunteer Opportunity","sidebarTitle":"Create a Volunteer Opportunity","openapi":"post /api/VolunteerOpportunity","description":null,"href":"/api-reference/volunteer-opportunity/creates-a-new-volunteer-opportunity-using-the-details-specified-in-the-post-model"},{"title":"Update a Volunteer Opportunity","sidebarTitle":"Update a Volunteer Opportunity","openapi":"put /api/VolunteerOpportunity/{volunteerOpportunityId}","description":null,"href":"/api-reference/volunteer-opportunity/updates-a-volunteer-opportunity-with-the-specified-identifier"},{"title":"Delete a Volunteer Opportunity","sidebarTitle":"Delete a Volunteer Opportunity","openapi":"delete /api/VolunteerOpportunity/{volunteerOpportunityId}","description":null,"href":"/api-reference/volunteer-opportunity/deletes-the-specified-volunteer-opportunity-with-the-specified-identifier"},{"title":"List Volunteer Opportunity Custom Fields","sidebarTitle":"List Volunteer Opportunity Custom Fields","openapi":"get /api/VolunteerOpportunity/CustomFields","description":"Will return all enabled custom fields available for the volunteer opportunities object.","href":"/api-reference/volunteer-opportunity/gets-the-custom-fields-for-volunteer-opportunities"},{"title":"Get Volunteer Opportunity Query Options","sidebarTitle":"Get Volunteer Opportunity Query Options","openapi":"get /api/VolunteerOpportunity/QueryOptions","description":null,"href":"/api-reference/volunteer-opportunity/get-volunteer-opportunity-query-options"},{"title":"Query Volunteer Opportunities","sidebarTitle":"Query Volunteer Opportunities","openapi":"post /api/VolunteerOpportunity/Query","description":null,"href":"/api-reference/volunteer-opportunity/query-volunteer-opportunities"}]},{"group":"Volunteer","pages":[{"title":"List Volunteers for an Opportunity","sidebarTitle":"List Volunteers for an Opportunity","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers","description":null,"href":"/api-reference/volunteer-opportunity/gets-all-volunteers-for-the-specified-volunteer-opportunity"},{"title":"Get a Volunteer","sidebarTitle":"Get a Volunteer","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers/{volunteerId}","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-volunteer-with-the-specified-identifier"},{"title":"Search Volunteers","sidebarTitle":"Search Volunteers","openapi":"get /api/Volunteer/Search","description":null,"href":"/api-reference/volunteer/search-for-volunteers"},{"title":"Create a Volunteer","sidebarTitle":"Create a Volunteer","openapi":"post /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers","description":null,"href":"/api-reference/volunteer-opportunity/create-a-new-volunteer-assigned-to-the-specified-volunteer-opportunity-using-the-details-in-the-specified-post-model"},{"title":"Delete a Volunteer","sidebarTitle":"Delete a Volunteer","openapi":"delete /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers/{volunteerId}","description":null,"href":"/api-reference/volunteer-opportunity/deletes-the-volunteer-with-the-specified-identifier"},{"title":"Get Volunteer Query Options","sidebarTitle":"Get Volunteer Query Options","openapi":"get /api/Volunteer/QueryOptions","description":null,"href":"/api-reference/volunteer/get-volunteer-query-options"},{"title":"Query Volunteers","sidebarTitle":"Query Volunteers","openapi":"post /api/Volunteer/Query","description":null,"href":"/api-reference/volunteer/query-volunteers"}]},{"group":"Volunteer Attendance","pages":[{"title":"List Attendance for a Volunteer","sidebarTitle":"List Attendance for a Volunteer","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers/{volunteerId}/Attendance","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-volunteer-attendance-for-the-specified-volunteer"},{"title":"Get a Volunteer Attendance","sidebarTitle":"Get a Volunteer Attendance","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Attendance/{volunteerAttendanceId}","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-volunteer-attendance-with-the-specified-identifier"},{"title":"Create a Volunteer Attendance","sidebarTitle":"Create a Volunteer Attendance","openapi":"post /api/VolunteerOpportunity/{volunteerOpportunityId}/Volunteers/{volunteerId}/Attendance","description":null,"href":"/api-reference/volunteer-opportunity/creates-a-volunteer-attendance-using-the-specified-volunteer-opportunity-and-volunteer-identifiers-and-the-details-of-the-specified-post-model"},{"title":"Update a Volunteer Attendance","sidebarTitle":"Update a Volunteer Attendance","openapi":"put /api/VolunteerOpportunity/{volunteerOpportunityId}/Attendance/{volunteerAttendanceId}","description":null,"href":"/api-reference/volunteer-opportunity/updates-the-volunteer-attendance-with-the-specified-identifier-using-the-details-in-the-specified-put-model"},{"title":"Delete a Volunteer Attendance","sidebarTitle":"Delete a Volunteer Attendance","openapi":"delete /api/VolunteerOpportunity/{volunteerOpportunityId}/Attendance/{volunteerAttendanceId}","description":null,"href":"/api-reference/volunteer-opportunity/deletes-the-volunteer-attendance-with-the-specified-identifier"}]},{"group":"Volunteer Organizer","pages":[{"title":"List Volunteer Organizers","sidebarTitle":"List Volunteer Organizers","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Organizers","description":null,"href":"/api-reference/volunteer-opportunity/gets-all-volunteer-organizers-for-the-specified-volunteer-opportunity"},{"title":"Get a Volunteer Organizer","sidebarTitle":"Get a Volunteer Organizer","openapi":"get /api/VolunteerOpportunity/{volunteerOpportunityId}/Organizers/{volunteerOrganizerId}","description":null,"href":"/api-reference/volunteer-opportunity/gets-the-specified-volunteer-organizer-with-the-specified-identifier"},{"title":"Create a Volunteer Organizer","sidebarTitle":"Create a Volunteer Organizer","openapi":"post /api/VolunteerOpportunity/{volunteerOpportunityId}/Organizers","description":null,"href":"/api-reference/volunteer-opportunity/creates-a-new-volunteer-organizer-assigned-to-the-specified-volunteer-opportunity-using-the-details-of-the-specified-post-model"},{"title":"Delete a Volunteer Organizer","sidebarTitle":"Delete a Volunteer Organizer","openapi":"delete /api/VolunteerOpportunity/{volunteerOpportunityId}/Organizers/{volunteerOrganizerId}","description":null,"href":"/api-reference/volunteer-opportunity/deletes-the-volunteer-organizer-with-the-specified-identifier"}]}]},{"group":"Emails","pages":[{"group":"Email","pages":[{"title":"Search Emails","sidebarTitle":"Search Emails","openapi":"post /api/Email/Search","description":null,"href":"/api-reference/email/get-the-emails-for-the-current-organization"},{"title":"Send an Email","sidebarTitle":"Send an Email","openapi":"post /api/Email/Send","description":null,"href":"/api-reference/email/send-an-email-to-a-list-of-contacts"}]},{"group":"Email List","pages":[{"title":"Search Email Lists","sidebarTitle":"Search Email Lists","openapi":"post /api/EmailList/Search","description":null,"href":"/api-reference/email-list/searches-the-email-lists"},{"title":"Add Individuals to an Email List","sidebarTitle":"Add Individuals to an Email List","openapi":"post /api/EmailList","description":"This endpoint places a message on a queue and will return an Accepted response. \r\nThe message will then be picked up by the queue and process adding individuals to a list.\r\nNote that this could take up to 4 hours to be completed. Do not use this endpoint to add a single individual to a list, wait and do them in bulk instead. \r\nDoing a single individual at a time will block up the organizations queue and will increase processing time.\r\nTo retrieve individual id's, use the api/ContactIndividual/Query.","href":"/api-reference/email-list/bulks-adds-individuals-to-email-lists"}]}]},{"group":"Reminders","pages":[{"group":"Reminders","tag":"Deprecated","pages":[{"title":"List Active Reminders","sidebarTitle":"List Active Reminders","openapi":"get /api/Reminder/Active","description":null,"href":"/api-reference/reminder/get-active-reminders-for-current-user"},{"title":"List Saved Reminders","sidebarTitle":"List Saved Reminders","openapi":"get /api/Reminder/Saved","description":null,"href":"/api-reference/reminder/get-saved-reminders-for-current-user"},{"title":"List Active Reminders for a Contact","sidebarTitle":"List Active Reminders for a Contact","openapi":"get /api/Reminder/ByContact/{contactId}/Active","description":null,"href":"/api-reference/reminder/get-active-manual-reminders-by-contact"},{"title":"List Inactive Reminders for a Contact","sidebarTitle":"List Inactive Reminders for a Contact","openapi":"get /api/Reminder/ByContact/{contactId}/Inactive","description":null,"href":"/api-reference/reminder/get-inactive-manual-reminders-by-contact"},{"title":"List Unresolved Reminders for a Contact","sidebarTitle":"List Unresolved Reminders for a Contact","openapi":"get /api/Reminder/ByContact/{contactId}","description":null,"href":"/api-reference/reminder/get-unresolved-manual-reminders-by-contact"},{"title":"Create a Reminder","sidebarTitle":"Create a Reminder","openapi":"post /api/Reminder","description":null,"href":"/api-reference/reminder/create-manual-reminder"},{"title":"Create a Recurring Reminder","sidebarTitle":"Create a Recurring Reminder","openapi":"post /api/Reminder/Saved/Recurring","description":null,"href":"/api-reference/reminder/create-recurring-reminder"},{"title":"Create a Milestone Reminder","sidebarTitle":"Create a Milestone Reminder","openapi":"post /api/Reminder/Saved/Milestone","description":null,"href":"/api-reference/reminder/create-milestone-reminder"},{"title":"Update a Recurring Reminder","sidebarTitle":"Update a Recurring Reminder","openapi":"put /api/Reminder/Saved/Recurring/{id}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/reminder/update-recurring-reminder"},{"title":"Update a Milestone Reminder","sidebarTitle":"Update a Milestone Reminder","openapi":"put /api/Reminder/Saved/Milestone/{id}","description":"Similar to other update methods in the API, excluding a property will remove it's value from the object. \r\nIf you're only updating a single property, the entire model is still required.","href":"/api-reference/reminder/update-milestone-reminder"},{"title":"Complete a Reminder","sidebarTitle":"Complete a Reminder","openapi":"put /api/Reminder/Completed/{id}","description":null,"href":"/api-reference/reminder/complete-reminder"},{"title":"Dismiss a Reminder","sidebarTitle":"Dismiss a Reminder","openapi":"put /api/Reminder/Dismissed/{id}","description":null,"href":"/api-reference/reminder/dismiss-reminder"},{"title":"List Reminder Types","sidebarTitle":"List Reminder Types","openapi":"get /api/Reminder/Type/Reminder","description":null,"href":"/api-reference/reminder/get-reminder-types"},{"title":"List Reminder Source Types","sidebarTitle":"List Reminder Source Types","openapi":"get /api/Reminder/Type/ReminderSource","description":null,"href":"/api-reference/reminder/get-reminder-source-types"},{"title":"List Milestone Types","sidebarTitle":"List Milestone Types","openapi":"get /api/Reminder/Type/Milestone","description":null,"href":"/api-reference/reminder/gets-milestone-types"},{"title":"List Reminder Frequency Types","sidebarTitle":"List Reminder Frequency Types","openapi":"get /api/Reminder/Type/ReminderFrequency","description":null,"href":"/api-reference/reminder/gets-reminder-frequency-types"}]}]},{"group":"Search","root":{"title":"Search","sidebarTitle":"Search","description":null,"href":"/api-reference/search"},"pages":[{"title":"Search for Contacts, Individuals or Entities","description":"Searches contacts, individuals, and other entities in one call and returns the matches grouped by type. Send the term in query, and use filterTypes to restrict which kinds of records are searched. Built for a global search box; for structured filtering on a single record type, use that type's query endpoint instead. Use skip and take to page through the results.","deprecated":null,"version":null,"openapi":"/crm/virtuous-crm-openapi-spec-2026.yaml post /api/Search","href":"/api-reference/search/search-for-contacts-individuals-or-entities"}]},{"group":"Tasks","root":{"title":"Tasks","sidebarTitle":"Tasks","description":null,"href":"/api-reference/tasks"},"pages":[{"title":"Create a Task","sidebarTitle":"Create a Task","openapi":"post /api/Task","description":null,"href":"/api-reference/task/create-a-task"},{"title":"Get a Task","sidebarTitle":"Get a Task","openapi":"get /api/Task/{id}","description":"Returns a task by its identifier, including its status, due date, and whether it is resolved or past due. You can get any task you could also find with the Query Tasks endpoint: administrators can get any task in the organization, and other users can get only the tasks they created or own. When you can't view the task's contact, the task is still returned with `contactId`, `contact`, and `contactUrl` set to null.","href":"/api-reference/task/get-a-task"},{"title":"Update a Task","sidebarTitle":"Update a Task","openapi":"put /api/Task/{id}","description":"Replaces a task's type, title, description, due date, contact, and contact individual with the values you send, and returns the task in its resulting state. This is a full update: `description`, `contactId`, and `contactIndividualId` are cleared when you leave them out. The one exception is a task whose contact you can't view. If you send no `contactId` for that task, its contact and contact individual are kept.\n\nThis endpoint doesn't change the status or owner. Use Change a Task's Status to change the status. Only tasks with a `taskKind` of `Reminder` can be updated, and a voided task can't be updated. If two requests update the same task at once, the last one wins.","href":"/api-reference/task/update-a-task"},{"title":"Change a Task's Status","sidebarTitle":"Change a Task's Status","openapi":"put /api/Task/{id}/Status","description":"Completes, dismisses, or reopens a task, and returns the task in its resulting state. Send the new status as `status`. The value is not case sensitive and can be the status name (`NotStarted`, `InProgress`, `Blocked`, `Completed`, `Dismissed`), its display name (for example `In Progress`), its number (0 to 4), or one of the aliases `Upcoming`, `In-progress`, `Complete`, `Done`, and `Finished`.\n\nCompleting or dismissing a task sets `resolutionDateTimeUtc`. Moving it back to Not Started, In Progress, or Blocked clears it. Sending the status the task already has changes nothing and returns `200`. Completing a task that an administrator assigned sends that administrator the same completion email as completing it in Virtuous.\n\nYou can't set a task to `Voided`, and you can't change the status of a voided task. If two requests change the same task at once, the last one wins.","href":"/api-reference/task/change-a-task-status"},{"title":"List Task Types","sidebarTitle":"List Task Types","openapi":"get /api/Task/Types","description":null,"href":"/api-reference/task/get-task-types"},{"title":"Query Tasks","sidebarTitle":"Query Tasks","openapi":"post /api/Task/Query","description":null,"href":"/api-reference/task/query-tasks"},{"title":"Get Task Query Options","sidebarTitle":"Get Task Query Options","openapi":"get /api/Task/QueryOptions","description":null,"href":"/api-reference/task/get-task-query-options"}]},{"group":"Webhooks","root":{"title":"Webhooks","href":"/api-reference/webhooks"},"pages":[{"title":"Get a Webhook","sidebarTitle":"Get a Webhook","openapi":"crm/virtuous-crm-openapi-spec-2026.yaml get /api/Webhook/{webhookId}","description":"Returns a single webhook, including its payload URL, whether it is active, and which events it is subscribed to. The signing secret is not returned.","href":"/api-reference/webhook/get-a-webhook-by-the-identifier"},{"title":"Create a Webhook","description":"Creates a webhook subscription.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json post /api/Webhook","href":"/api-reference/webhook/create-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":"Toggle Webhook Active State","sidebarTitle":"Toggle Webhook Active State","openapi":"crm/virtuous-crm-openapi-spec-2026.yaml put /api/Webhook/{webhookId}/Active","description":"Activates or pauses delivery for the webhook. Pass active=true to resume delivery and active=false to pause it, leaving the payload URL and event subscriptions in place. The signing secret is not returned.","href":"/api-reference/webhook/set-the-active-state-of-a-webhook"},{"title":"Delete a Webhook","description":"Deletes a webhook subscription so its URL stops receiving events.","deprecated":null,"version":null,"openapi":"/raise/RaiseAPIOpenAPI.json delete /api/Webhook/{id}","href":"/api-reference/webhook/delete-a-webhook"},{"title":"Add RaiseDonors Tenant ID to Webhook Headers","sidebarTitle":"Add RaiseDonors Tenant ID to Webhook Headers","openapi":"post /api/Webhook/RaiseDonors/Tenant/{tenantId}","description":"HMAC or OAuth Auth valid. This is the recommended way to update projects.","href":"/api-reference/webhook/add-raisedonors-tenant-id-to-webhook-headers"}]},{"group":"PenTest","pages":[{"group":"MIME Type Sniffing","pages":[{"title":"Campaign by ID","sidebarTitle":"Campaign by ID","openapi":"get /api/Campaign/{campaignId}","description":null,"href":"/api-reference/pentest/get-campaign-by-id"},{"title":"Campaign Query","sidebarTitle":"Campaign Query","openapi":"post /api/Campaign/Query","description":"To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.CampaignController.QueryOptions} endpoint.\r\nIf requests are timing out, you may be asking for too many items at once. The max take is 1,000.","href":"/api-reference/pentest/query-campaigns"},{"title":"CustomField Search","sidebarTitle":"CustomField Search","openapi":"post /api/CustomField/Search","description":null,"href":"/api-reference/pentest/custom-field-search"},{"title":"Gift By Reference","sidebarTitle":"Gift By Reference","openapi":"get /api/Gift/ByReference/{referenceId}","description":"HMAC Auth only.","href":"/api-reference/pentest/gift-by-reference"},{"title":"Contact Transaction","sidebarTitle":"Contact Transaction","openapi":"post /api/Contact/Transaction","description":null,"href":"/api-reference/pentest/contact-transaction"},{"title":"Organization Switch","sidebarTitle":"Organization Switch","openapi":"put /api/Organization/Switch","description":null,"href":"/api-reference/pentest/organization-switch"}]}]}]}]},{"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","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","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","description":"Returns a single webhook subscription by ID.","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","description":"Deletes a webhook subscription so its URL stops receiving events.","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 Webhook - 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"]}