Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.
An admin user — staff member of a client organization. Authenticates via Laravel Passport (bearer JWT) for the admin web app, and may also issue API keys (via ApiKey) for server-to-server integrations. Permissions are stored as JSON keyed by feature; group membership (group_id) supplies a baseline permission set on top of the per-user override.
{
"message": "This activation link is invalid or expired."
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Gratona Docs","colors":{"primary":"#5B4CF0","light":"#7B6FF5","dark":"#4035C8"},"logo":{"light":"https://mintcdn.com/hys/BYYpU1AlfZdVDeif/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=BYYpU1AlfZdVDeif\u0026q=85\u0026s=42b87b9ecd11cf70bc986fbea46accf7","dark":"https://mintcdn.com/hys/BYYpU1AlfZdVDeif/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=BYYpU1AlfZdVDeif\u0026q=85\u0026s=1fc88c3d21feb2788e08e0bda42fbb9a"},"favicon":"https://mintcdn.com/hys/BYYpU1AlfZdVDeif/favicon.svg?fit=max\u0026auto=format\u0026n=BYYpU1AlfZdVDeif\u0026q=85\u0026s=ac482df39e533f31dd080ea40d6aabb2","navbar":{"links":[],"primary":{"type":"button","label":"Go to Gratona","href":"https://gratona.com"}},"footer":{"socials":{"website":"https://gratona.com"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://gratona.com/docs"},{"anchor":"Blog","icon":"newspaper","href":"https://gratona.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hys","hasAudioNarration":false,"actualSubdomain":"hys","customDomains":["api-docs.helpyousponsor.com"],"gitSource":{"type":"github","owner":"rg-repos","repo":"hys_mintlify_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7a7f924c2d4847cf1aa71","collectionId":"90e5b5b9-bc0e-463e-a9f5-22aed5c7da54","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7a7f924c2d4847cf1aa71"},"entitlements":{},"buildId":"6ad7a7f924c2d4847cf1aa71","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1776},{"language":"default","tag":"Communications","count":157},{"language":"default","tag":"Integrations","count":154},{"language":"default","tag":"Events","count":136},{"language":"default","tag":"Donors","count":112},{"language":"default","tag":"Trips","count":109},{"language":"default","tag":"Fundraising","count":102},{"language":"default","tag":"Intelligence","count":80},{"language":"default","tag":"Donations","count":69},{"language":"default","tag":"Files","count":65}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/auth/redeem-an-administrator-activation-link","slug":"/api-reference/auth/redeem-an-administrator-activation-link","pageMetadata":{"openapi":"post /user/email/verification","title":"Redeem an administrator activation link","description":"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.","href":"/api-reference/auth/redeem-an-administrator-activation-link"},"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: \"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\"\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"openapi":"post /user/email/verification","title":"Redeem an administrator activation link","description":"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.","href":"/api-reference/auth/redeem-an-administrator-activation-link"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Auth"],"summary":"Redeem an administrator activation link","description":"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.","operationId":"1d60f530b0b9afd4aba90aa1e86d11d5","requestBody":"6425d8ea-d6fa-4fc3-9984-4f6e9441790d","responses":{"200":"fbcab812-4524-46f8-8dc0-da72f4374c32","403":"bc57b623-f18b-42c1-b992-1d9cd168eed7","422":"9c3616bd-f58e-42bc-86e5-89421af4dc2c"},"security":[],"method":"post","type":"path","servers":["91dc3723-0c60-4df3-a9e8-fa84abc223ec"],"path":"/user/email/verification","baseUrlOptions":["https://api.gratona.com/v1"],"title":"Redeem an administrator activation link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Data required for user activation","required":true,"content":{"application/json":{"schema":{"required":["id","activationCode"],"properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"activationCode":{"description":"The signed admin:activate bearer credential from the activation email.","type":"string","isRequired":true,"uniqueKey":"activationCode","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"activationCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fbcab812-4524-46f8-8dc0-da72f4374c32":{"description":"Activation credential redeemed","content":{"application/json":{"schema":{"properties":{"status":{"type":"string","example":"success","uniqueKey":"status","typeLabel":"string"},"token":{"description":"Authenticated administrator Passport bearer token.","type":"string","uniqueKey":"token","typeLabel":"string"},"user":{"title":"User","description":"An admin user — staff member of a client organization. Authenticates via Laravel Passport (bearer JWT) for the admin web app, and may also issue API keys (via `ApiKey`) for server-to-server integrations. Permissions are stored as JSON keyed by feature; group membership (`group_id`) supplies a baseline permission set on top of the per-user override.","required":["id","email","client_id"],"properties":{"id":{"description":"Internal user ID.","type":"integer","format":"int64","example":1024,"isRequired":true,"uniqueKey":"user.id","typeLabel":"integer\u003cint64>"},"email":{"description":"User email — also the login identifier. Unique across the whole users table.","type":"string","format":"email","example":"staff@gratona.com","isRequired":true,"uniqueKey":"user.email","typeLabel":"string\u003cemail>"},"client_id":{"description":"Client (tenant) the user belongs to. Stored as string for historical reasons; numeric in practice.","type":"string","example":"207","isRequired":true,"uniqueKey":"user.client_id","typeLabel":"string"},"first_name":{"oneOf":[{"description":"Given name.","type":"string","example":"Alex","uniqueKey":"user.first_name.oneOf.0","typeLabel":"string"},{"description":"Given name.","type":"null","example":"Alex","uniqueKey":"user.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Family name.","type":"string","example":"Morgan","uniqueKey":"user.last_name.oneOf.0","typeLabel":"string"},{"description":"Family name.","type":"null","example":"Morgan","uniqueKey":"user.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.last_name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Optional phone number for SMS / call notifications.","type":"string","example":"+15551234567","uniqueKey":"user.phone.oneOf.0","typeLabel":"string"},{"description":"Optional phone number for SMS / call notifications.","type":"null","example":"+15551234567","uniqueKey":"user.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.phone","typeLabel":"string | null"},"group_id":{"oneOf":[{"description":"Permission group the user belongs to; supplies baseline permissions before the per-user override.","type":"integer","format":"int64","example":4,"uniqueKey":"user.group_id.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"Permission group the user belongs to; supplies baseline permissions before the per-user override.","type":"null","format":"int64","example":4,"uniqueKey":"user.group_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.group_id","typeLabel":"integer\u003cint64> | null"},"permissions":{"oneOf":[{"description":"Per-user permission overrides as a JSON map keyed by permission slug. Values are typically the string `1` (granted) or absent. Merged with group permissions at request time. Example: `{group_all: 1, donor-42: 1}`.","type":"object","additionalProperties":true,"uniqueKey":"user.permissions.oneOf.0","typeLabel":"object"},{"description":"Per-user permission overrides as a JSON map keyed by permission slug. Values are typically the string `1` (granted) or absent. Merged with group permissions at request time. Example: `{group_all: 1, donor-42: 1}`.","type":"null","additionalProperties":true,"uniqueKey":"user.permissions.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.permissions","typeLabel":"object | null"},"onboarding_status":{"oneOf":[{"description":"Onboarding-flow stage marker. `3` = onboarding complete; lower values indicate the user is still in setup.","type":"string","example":"3","uniqueKey":"user.onboarding_status.oneOf.0","typeLabel":"string"},{"description":"Onboarding-flow stage marker. `3` = onboarding complete; lower values indicate the user is still in setup.","type":"null","example":"3","uniqueKey":"user.onboarding_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.onboarding_status","typeLabel":"string | null"},"activated":{"description":"Whether the account is activated (email verified / activation code redeemed).","type":"boolean","example":true,"uniqueKey":"user.activated","typeLabel":"boolean"},"access_disabled_at":{"oneOf":[{"description":"Administrative disable timestamp. Authorized admin payloads expose it so clients can distinguish disabled access from a pending mailbox-proof invitation.","type":"string","format":"date-time","example":null,"uniqueKey":"user.access_disabled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Administrative disable timestamp. Authorized admin payloads expose it so clients can distinguish disabled access from a pending mailbox-proof invitation.","type":"null","format":"date-time","example":null,"uniqueKey":"user.access_disabled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.access_disabled_at","typeLabel":"string\u003cdate-time> | null"},"is_platform_admin":{"description":"Server-resolved platform authority. Clients must treat false or missing as no platform authority and must not infer this grant from persisted roles or legacy ids.","type":"boolean","example":false,"uniqueKey":"user.is_platform_admin","typeLabel":"boolean"},"activation_code":{"oneOf":[{"description":"Pending activation token — null after activation.","type":"string","example":null,"uniqueKey":"user.activation_code.oneOf.0","typeLabel":"string"},{"description":"Pending activation token — null after activation.","type":"null","example":null,"uniqueKey":"user.activation_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.activation_code","typeLabel":"string | null"},"activated_at":{"oneOf":[{"type":"string","format":"date-time","example":"2024-06-15T10:00:00Z","uniqueKey":"user.activated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2024-06-15T10:00:00Z","uniqueKey":"user.activated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.activated_at","typeLabel":"string\u003cdate-time> | null"},"last_login":{"oneOf":[{"type":"string","format":"date-time","example":"2026-04-29T14:01:00Z","uniqueKey":"user.last_login.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-04-29T14:01:00Z","uniqueKey":"user.last_login.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.last_login","typeLabel":"string\u003cdate-time> | null"},"email_verified_at":{"oneOf":[{"type":"string","format":"date-time","example":"2024-06-15T10:00:00Z","uniqueKey":"user.email_verified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2024-06-15T10:00:00Z","uniqueKey":"user.email_verified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"user.email_verified_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","example":"2024-06-15T09:50:00Z","uniqueKey":"user.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-04-29T14:01:00Z","uniqueKey":"user.updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","uniqueKey":"user","typeLabel":"User · object"},"permissions":{"type":"object","additionalProperties":true,"uniqueKey":"permissions","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","token":"\u003cstring>","user":{"id":1024,"email":"staff@gratona.com","client_id":"207","first_name":"Alex","last_name":"Morgan","phone":"+15551234567","group_id":4,"permissions":{},"onboarding_status":"3","activated":true,"access_disabled_at":null,"is_platform_admin":false,"activation_code":null,"activated_at":"2024-06-15T10:00:00Z","last_login":"2026-04-29T14:01:00Z","email_verified_at":"2024-06-15T10:00:00Z","created_at":"2024-06-15T09:50:00Z","updated_at":"2026-04-29T14:01:00Z"},"permissions":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"bc57b623-f18b-42c1-b992-1d9cd168eed7":{"description":"Missing, expired, wrong-purpose, wrong-user, or already-redeemed credential","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","example":"This activation link is invalid or expired.","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"This activation link is invalid or expired."}}},"exampleType":"generated"}},"exampleType":"generated"},"9c3616bd-f58e-42bc-86e5-89421af4dc2c":{"description":"Validation failure","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"91dc3723-0c60-4df3-a9e8-fa84abc223ec":{"url":"https://api.gratona.com/v1","description":"Server Version 1.0.0"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"hys","siteName":"Gratona Docs","title":"Redeem an administrator activation link - Gratona Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T12:35:16.470Z","originalFileLocation":"api-reference/auth/redeem-an-administrator-activation-link.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=\"system\"}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=\"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gratona Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_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/hys/nQYjmsFhogtltHGV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Redeem an administrator activation link - Gratona Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gratona Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hys.mintlify.app/_mintlify/api/og/v2?division=Auth\u0026amp;title=Redeem+an+administrator+activation+link\u0026amp;description=Consumes+a+one-time%2C+purpose-bound+invitation+credential.+Successful+redemption+proves+mailbox+ownership%2C+activates+the+member%2C+and+returns+the+same+authenticat\u0026amp;theme=553395aa34b0361d31473541\u0026amp;signature=2224d4a247a5fbb462a863072949e1fabb94d3a6c34c689c24fe2ff1a9338026\">\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=\"Redeem an administrator activation link - Gratona Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hys.mintlify.app/_mintlify/api/og/v2?division=Auth\u0026amp;title=Redeem+an+administrator+activation+link\u0026amp;description=Consumes+a+one-time%2C+purpose-bound+invitation+credential.+Successful+redemption+proves+mailbox+ownership%2C+activates+the+member%2C+and+returns+the+same+authenticat\u0026amp;theme=553395aa34b0361d31473541\u0026amp;signature=2224d4a247a5fbb462a863072949e1fabb94d3a6c34c689c24fe2ff1a9338026\">\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/hys/nQYjmsFhogtltHGV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gratona Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4CF0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/auth/redeem-an-administrator-activation-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-docs.helpyousponsor.com/#organization\",\"name\":\"Gratona Docs\",\"url\":\"https://api-docs.helpyousponsor.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hys/BYYpU1AlfZdVDeif/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=BYYpU1AlfZdVDeif\u0026q=85\u0026s=42b87b9ecd11cf70bc986fbea46accf7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-docs.helpyousponsor.com#website\",\"name\":\"Gratona Docs\",\"url\":\"https://api-docs.helpyousponsor.com\",\"publisher\":{\"@id\":\"https://api-docs.helpyousponsor.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link#webpage\",\"url\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link\",\"name\":\"Redeem an administrator activation link\",\"description\":\"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\",\"dateModified\":\"2026-10-20T12:35:16.470Z\",\"isPartOf\":{\"@id\":\"https://api-docs.helpyousponsor.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Auth\",\"item\":\"https://api-docs.helpyousponsor.com/api-reference/auth/admin-user-login\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Redeem an administrator activation link\",\"item\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link#apireference\",\"headline\":\"Redeem an administrator activation link\",\"name\":\"Redeem an administrator activation link\",\"description\":\"Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.\",\"url\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.helpyousponsor.com/api-reference/auth/redeem-an-administrator-activation-link#webpage\"},\"dateModified\":\"2026-10-20T12:35:16.470Z\",\"publisher\":{\"@id\":\"https://api-docs.helpyousponsor.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api-docs.helpyousponsor.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gratona Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gratona Docs","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://gratona.com/docs"},{"anchor":"Blog","icon":"newspaper","href":"https://gratona.com/blog"}]},"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/importing-recipient-photos"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Admin","pages":[{"openapi":"post /admin/settings","title":"Add new setting","href":"/api-reference/admin/add-new-setting"},{"openapi":"get /client/admins/{id}","title":"Admin details","href":"/api-reference/admin/admin-details"},{"openapi":"get /admin/add_settings","title":"Bootstrap data for the new-settings form","href":"/api-reference/admin/bootstrap-data-for-the-new-settings-form"},{"openapi":"put /admin/access/resources/{resource_type}/{resource_id}/roles/{role_id}","title":"Change a role access level for a program","href":"/api-reference/admin/change-a-role-access-level-for-a-program"},{"openapi":"put /admin/access/resources/{resource_type}/roles/{role_id}","title":"Change a role access level for an organization feature","href":"/api-reference/admin/change-a-role-access-level-for-an-organization-feature"},{"openapi":"post /admin/workspace-setup","title":"Confirm workspace setup choices","href":"/api-reference/admin/confirm-workspace-setup-choices"},{"openapi":"post /admin/access/roles","title":"Create an empty access role","href":"/api-reference/admin/create-an-empty-access-role"},{"openapi":"post /admin/customer-feedback/session","title":"Create my customer feedback provider session","href":"/api-reference/admin/create-my-customer-feedback-provider-session"},{"openapi":"post /admin/account/decommission","title":"Decommission the current organization account","href":"/api-reference/admin/decommission-the-current-organization-account"},{"openapi":"delete /admin/settings/{settings_id}","title":"Delete a setting","href":"/api-reference/admin/delete-a-setting"},{"openapi":"delete /admin/access/roles/{role_id}","title":"Delete an empty access role","href":"/api-reference/admin/delete-an-empty-access-role"},{"openapi":"put /admin/settings/{settings_id}","title":"Edit a setting","href":"/api-reference/admin/edit-a-setting"},{"openapi":"put /client/admins/{id}","title":"Edit an existing admin","href":"/api-reference/admin/edit-an-existing-admin"},{"openapi":"get /admin/settings","title":"Get all settings","href":"/api-reference/admin/get-all-settings"},{"openapi":"get /admin/settings/{settings_id}","title":"Get details for a setting","href":"/api-reference/admin/get-details-for-a-setting"},{"openapi":"get /admin/campaign/settings/{settings_id}","title":"Get details for campaign settings","href":"/api-reference/admin/get-details-for-campaign-settings"},{"openapi":"post /client/admin/{client_id}","title":"Invite a team member","href":"/api-reference/admin/invite-a-team-member"},{"openapi":"post /admin/generate_api_key","title":"Issue a new API key for the current admin","href":"/api-reference/admin/issue-a-new-api-key-for-the-current-admin"},{"openapi":"get /admin/access/roles","title":"List organization access roles","href":"/api-reference/admin/list-organization-access-roles"},{"openapi":"get /client/admin/{client_id}","title":"List permission sets or admin groups","href":"/api-reference/admin/list-permission-sets-or-admin-groups"},{"openapi":"get /admin/api_keys","title":"List the calling admin's API keys","href":"/api-reference/admin/list-the-calling-admins-api-keys"},{"openapi":"get /admin/account/{id}/deactivate","title":"Manually deactivate an admin","href":"/api-reference/admin/manually-deactivate-an-admin"},{"openapi":"patch /admin/onboarding_checklist","title":"Mark a legacy onboarding checklist step complete","href":"/api-reference/admin/mark-a-legacy-onboarding-checklist-step-complete"},{"openapi":"patch /admin/settings/{settings_id}/defaults","title":"Patch a campaign's default amount and/or frequency","href":"/api-reference/admin/patch-a-campaigns-default-amount-andor-frequency"},{"openapi":"get /admin/account/{id}/activate","title":"Prepare an administrator for mailbox reactivation","href":"/api-reference/admin/prepare-an-administrator-for-mailbox-reactivation"},{"openapi":"get /admin/workspace-activation/starter-preview","title":"Preview private workspace starters","href":"/api-reference/admin/preview-private-workspace-starters"},{"openapi":"get /admin/reload_stats","title":"Queue dashboard statistics refresh","href":"/api-reference/admin/queue-dashboard-statistics-refresh"},{"openapi":"get /admin/access/history","title":"Read access change audit history","href":"/api-reference/admin/read-access-change-audit-history"},{"openapi":"get /admin/access/resources/{resource_type}","title":"Read access roles for a feature or program","href":"/api-reference/admin/read-access-roles-for-a-feature-or-program"},{"openapi":"get /admin/access/resources/{resource_type}/{resource_id}","title":"Read access roles for a feature or program","href":"/api-reference/admin/read-access-roles-for-a-feature-or-program-1"},{"openapi":"get /admin/activityLogs/facets","title":"Read activity action and table facet counts","href":"/api-reference/admin/read-activity-action-and-table-facet-counts"},{"openapi":"get /admin/access/roles/{role_id}","title":"Read an access role and allowed transitions","href":"/api-reference/admin/read-an-access-role-and-allowed-transitions"},{"openapi":"get /admin/access/manifest","title":"Read my effective access manifest","href":"/api-reference/admin/read-my-effective-access-manifest"},{"openapi":"get /admin/workspace-activation","title":"Read my workspace activation guide","href":"/api-reference/admin/read-my-workspace-activation-guide"},{"openapi":"get /admin/activityLogs","title":"Read organization or record activity","href":"/api-reference/admin/read-organization-or-record-activity"},{"openapi":"get /admin/permissions/schema","title":"Read the canonical permissions editor schema","href":"/api-reference/admin/read-the-canonical-permissions-editor-schema"},{"openapi":"get /admin/onboarding_checklist","title":"Read the legacy onboarding checklist","href":"/api-reference/admin/read-the-legacy-onboarding-checklist"},{"openapi":"get /admin/access/overview","title":"Read the team access matrix","href":"/api-reference/admin/read-the-team-access-matrix"},{"openapi":"get /admin/entitlements","title":"Read workspace plan entitlements and AI usage","href":"/api-reference/admin/read-workspace-plan-entitlements-and-ai-usage"},{"openapi":"get /admin/workspace-setup","title":"Read workspace setup choices","href":"/api-reference/admin/read-workspace-setup-choices"},{"openapi":"post /admin/workspace-activation/tasks/{taskKey}","title":"Record a manual activation step event","href":"/api-reference/admin/record-a-manual-activation-step-event"},{"openapi":"delete /client/admins/{id}","title":"Remove an admin","href":"/api-reference/admin/remove-an-admin"},{"openapi":"post /admin/clients/archive","title":"Retired legacy client archive endpoint","href":"/api-reference/admin/retired-legacy-client-archive-endpoint"},{"openapi":"post /admin_login","title":"Retired legacy teammate enrollment endpoint","href":"/api-reference/admin/retired-legacy-teammate-enrollment-endpoint"},{"openapi":"post /admin/revoke_api_token","title":"Revoke an API key or a Passport access token","href":"/api-reference/admin/revoke-an-api-key-or-a-passport-access-token"},{"openapi":"put /admin/access/roles/{role_id}","title":"Update an access role with version protection","href":"/api-reference/admin/update-an-access-role-with-version-protection"},{"openapi":"get /admins","title":"View all admins","href":"/api-reference/admin/view-all-admins"}]},{"group":"Admin Dashboard","pages":[{"openapi":"get /dashboard","title":"Get admin dashboard data","href":"/api-reference/admin-dashboard/get-admin-dashboard-data"}]},{"group":"Auth","pages":[{"openapi":"post /login","title":"Admin user login","href":"/api-reference/auth/admin-user-login"},{"openapi":"get /admin_signup/{client_id}/{group_id}","title":"Check a retired teammate enrollment link","href":"/api-reference/auth/check-a-retired-teammate-enrollment-link"},{"openapi":"get /user/{id}/activation/status","title":"Check User Activation Status","href":"/api-reference/auth/check-user-activation-status"},{"openapi":"post /password/setup","title":"Complete an administrator account setup link","href":"/api-reference/auth/complete-an-administrator-account-setup-link"},{"openapi":"get /logout_status/{client_id}","title":"Get a legacy organization logout flag","href":"/api-reference/auth/get-a-legacy-organization-logout-flag"},{"openapi":"get /user","title":"Get the currently authenticated admin user","description":"Returns the authenticated admin user along with current permissions, feature entitlements and the server-derived access manifest. Used by the admin web app on app boot / route guard checks. Requires authentication via Passport bearer token or API key. Returns 401 if unauthenticated and 403 when onboarding, workspace, membership or access-role eligibility blocks access.","href":"/api-reference/auth/get-the-currently-authenticated-admin-user"},{"openapi":"post /user/email/verification","title":"Redeem an administrator activation link","href":"/api-reference/auth/redeem-an-administrator-activation-link"},{"openapi":"get /admin/passwordless_verify/{token}","title":"Redeem an administrator email sign-in link","description":"Consumes the one-time passwordless challenge shared by the email link and verification-code transports. Exactly one redemption can create a session. A valid mailbox proof must still pass current organization, membership and access-role eligibility. Successful redemption issues a bearer token and returns the authenticated user, access manifest, entitlements and billing context. A lifecycle lock conflict returns409 with Retry-After30seconds.","href":"/api-reference/auth/redeem-an-administrator-email-sign-in-link"},{"openapi":"post /admin/passwordless_login","title":"Request an admin passwordless sign-in","href":"/api-reference/auth/request-an-admin-passwordless-sign-in"},{"openapi":"post /user/{id}/send_verification_email","title":"Resend a team invitation or mailbox verification email","href":"/api-reference/auth/resend-a-team-invitation-or-mailbox-verification-email"},{"openapi":"post /password/reset","title":"Reset a password using a reset token","href":"/api-reference/auth/reset-a-password-using-a-reset-token"},{"openapi":"post /password/forgot","title":"Send a password reset link","href":"/api-reference/auth/send-a-password-reset-link"},{"openapi":"post /email/verification-notification","title":"Send an administrator activation email","href":"/api-reference/auth/send-an-administrator-activation-email"},{"openapi":"get /logout","title":"User Logout","href":"/api-reference/auth/user-logout"},{"openapi":"post /admin/passwordless_verify_code","title":"Verify an admin passwordless code","href":"/api-reference/auth/verify-an-admin-passwordless-code"},{"openapi":"post /email/verify","title":"Verify my administrator email","href":"/api-reference/auth/verify-my-administrator-email"}]},{"group":"Automation","pages":[{"openapi":"get /primitives/{name}/schema","title":"Get an automation primitive schema","href":"/api-reference/automation/get-an-automation-primitive-schema"},{"openapi":"post /primitives/{name}/invoke","title":"Invoke an automation primitive","href":"/api-reference/automation/invoke-an-automation-primitive"},{"openapi":"get /primitives","title":"List available automation primitives","href":"/api-reference/automation/list-available-automation-primitives"},{"openapi":"post /primitives/{name}/validate","title":"Validate an automation primitive input","href":"/api-reference/automation/validate-an-automation-primitive-input"}]},{"group":"Client","pages":[{"openapi":"post /client/pay","title":"Client payment","href":"/api-reference/client/client-payment"},{"openapi":"put /client","title":"Edit client account","href":"/api-reference/client/edit-client-account"},{"openapi":"post /integrations/{name}","title":"Edit client integration","href":"/api-reference/client/edit-client-integration"},{"openapi":"get /client/credit-card","title":"Get client card details","href":"/api-reference/client/get-client-card-details"},{"openapi":"get /client/{id}/payment-status","title":"Get client payment status","href":"/api-reference/client/get-client-payment-status"},{"openapi":"get /client/payments","title":"Get client payments","href":"/api-reference/client/get-client-payments"},{"openapi":"get /client/subscriptions","title":"Get client subscriptions by module","href":"/api-reference/client/get-client-subscriptions-by-module"},{"openapi":"get /integrations/{name}","title":"Get details of an integration","href":"/api-reference/client/get-details-of-an-integration"},{"openapi":"get /client/payment-intent","title":"Get payment intent","href":"/api-reference/client/get-payment-intent"},{"openapi":"get /client/{id}/price","title":"Get price for client to pay","href":"/api-reference/client/get-price-for-client-to-pay"},{"openapi":"get /color_theme","title":"Get the public organization theme","href":"/api-reference/client/get-the-public-organization-theme"},{"openapi":"get /client_tags","title":"List organization donor or recipient tags","href":"/api-reference/client/list-organization-donor-or-recipient-tags"},{"openapi":"post /admin/client/{client_id}/migrate-stripe-connect","title":"Migrate from Stripe Connect to Stripe API keys","href":"/api-reference/client/migrate-from-stripe-connect-to-stripe-api-keys"},{"openapi":"post /admin/switch_client","title":"Read retired organization-switching response","href":"/api-reference/client/read-retired-organization-switching-response"},{"openapi":"post /client/client-custom/{client_id}","title":"Save organization custom pricing configuration","href":"/api-reference/client/save-organization-custom-pricing-configuration"},{"openapi":"post /client/credit-card","title":"Update client credit card","href":"/api-reference/client/update-client-credit-card"},{"openapi":"put /admin/color_theme","title":"Update the organization default accent","href":"/api-reference/client/update-the-organization-default-accent"},{"openapi":"get /integrations","title":"View Integrations","href":"/api-reference/client/view-integrations"}]},{"group":"Communications","pages":[{"openapi":"post /admin/email/settings/sending-domains/{domainId}/activate","title":"Activate verified email sending","href":"/api-reference/communications/activate-verified-email-sending"},{"openapi":"post /admin/auto_emails/emailset","title":"Add a new email set","href":"/api-reference/communications/add-a-new-email-set"},{"openapi":"post /unsubscribe/one-click","title":"Apply a mailbox one-click unsubscribe","href":"/api-reference/communications/apply-a-mailbox-one-click-unsubscribe"},{"openapi":"post /admin/message/approve/draft/{email_id}","title":"Approve a draft message","href":"/api-reference/communications/approve-a-draft-message"},{"openapi":"post /admin/recipient-messages/{id}/approve","title":"Approve a pending recipient message","href":"/api-reference/communications/approve-a-pending-recipient-message"},{"openapi":"post /admin/newsLetters/{id}/approve","title":"Approve and send a draft newsletter","href":"/api-reference/communications/approve-and-send-a-draft-newsletter"},{"openapi":"put /admin/message/draft/response/{email_id}/approve","title":"Approve and send a draft response","href":"/api-reference/communications/approve-and-send-a-draft-response"},{"openapi":"post /admin/message/drafts/approve","title":"Approve and send multiple draft messages","href":"/api-reference/communications/approve-and-send-multiple-draft-messages"},{"openapi":"delete /admin/mailing_templates/{id}","title":"Archive a custom mailing template","href":"/api-reference/communications/archive-a-custom-mailing-template"},{"openapi":"delete /admin/notes/categories/{category_id}","title":"Archive a profile-note category","href":"/api-reference/communications/archive-a-profile-note-category"},{"openapi":"put /admin/email/assign_admin","title":"Assign an email to an admin","href":"/api-reference/communications/assign-an-email-to-an-admin"},{"openapi":"post /admin/sms_inbox/conversations/{conversation_id}/assign","title":"Assign an SMS conversation","href":"/api-reference/communications/assign-an-sms-conversation"},{"openapi":"put /admin/emails/assign_admin","title":"Assign multiple emails to an admin","href":"/api-reference/communications/assign-multiple-emails-to-an-admin"},{"openapi":"post /admin/newsLetters/{id}/cancel","title":"Cancel a scheduled newsletter","href":"/api-reference/communications/cancel-a-scheduled-newsletter"},{"openapi":"post /admin/sms_inbox/conversations/{conversation_id}/status","title":"Change an SMS conversation inbox status","href":"/api-reference/communications/change-an-sms-conversation-inbox-status"},{"openapi":"post /admin/mailing_templates/{id}/preflight","title":"Check a mailing generation audience","href":"/api-reference/communications/check-a-mailing-generation-audience"},{"openapi":"post /admin/email/settings/sending-domains/{domainId}/check","title":"Check sending domain DNS verification","href":"/api-reference/communications/check-sending-domain-dns-verification"},{"openapi":"post /admin/auto_emails/emailset/{emailset_id}/clone","title":"Clone an auto-email set","href":"/api-reference/communications/clone-an-auto-email-set"},{"openapi":"post /admin/newsLetters/{id}/clone","title":"Clone newsletter content or audience","href":"/api-reference/communications/clone-newsletter-content-or-audience"},{"openapi":"get /admin/donors/count","title":"Count organization donor records","href":"/api-reference/communications/count-organization-donor-records"},{"openapi":"post /admin/auto_sms/template","title":"Create a custom automated SMS template","href":"/api-reference/communications/create-a-custom-automated-sms-template"},{"openapi":"post /admin/mailing_templates","title":"Create a custom mailing template","href":"/api-reference/communications/create-a-custom-mailing-template"},{"openapi":"post /admin/auto_emails/template/variant","title":"Create a donation-type email template variant","href":"/api-reference/communications/create-a-donation-type-email-template-variant"},{"openapi":"post /admin/message/draft/{entity_id}/{from}/{file_id}","title":"Create a draft message","href":"/api-reference/communications/create-a-draft-message"},{"openapi":"post /admin/send/newsLetter","title":"Create a draft, send, or schedule a newsletter","href":"/api-reference/communications/create-a-draft-send-or-schedule-a-newsletter"},{"openapi":"post /admin/auto_emails/template","title":"Create a new email template","href":"/api-reference/communications/create-a-new-email-template"},{"openapi":"post /admin/notes/{type}/{program_id}","title":"Create a new note","href":"/api-reference/communications/create-a-new-note"},{"openapi":"post /notes","title":"Create a new note","href":"/api-reference/communications/create-a-new-note-1"},{"openapi":"post /admin/notes/categories/{type}/{program_id}","title":"Create a profile-note category","href":"/api-reference/communications/create-a-profile-note-category"},{"openapi":"post /admin/auto_sms/template/variant","title":"Create an automated SMS receipt variant","href":"/api-reference/communications/create-an-automated-sms-receipt-variant"},{"openapi":"post /admin/auto_sms/smsset","title":"Create an automated SMS set","href":"/api-reference/communications/create-an-automated-sms-set"},{"openapi":"post /admin/email/settings/sending-domains/{domainId}/deactivate","title":"Deactivate verified email sending","href":"/api-reference/communications/deactivate-verified-email-sending"},{"openapi":"delete /admin/auto_sms/template/{id}","title":"Delete a custom automated SMS template","href":"/api-reference/communications/delete-a-custom-automated-sms-template"},{"openapi":"delete /admin/newsLetters/{id}","title":"Delete a draft newsletter","href":"/api-reference/communications/delete-a-draft-newsletter"},{"openapi":"delete /admin/notes/{note_id}","title":"Delete a note","href":"/api-reference/communications/delete-a-note"},{"openapi":"delete /notes/{id}","title":"Delete a note","href":"/api-reference/communications/delete-a-note-1"},{"openapi":"get /admin/remove_template_pic/{id}","title":"Delete a template image","href":"/api-reference/communications/delete-a-template-image"},{"openapi":"delete /admin/messages/drafts/delete","title":"Delete draft donor messages","href":"/api-reference/communications/delete-draft-donor-messages"},{"openapi":"delete /admin/auto_emails/template/{id}","title":"Delete email template","href":"/api-reference/communications/delete-email-template"},{"openapi":"get /admin/communications/coverage/exports/{exportId}","title":"Download a communication coverage export","href":"/api-reference/communications/download-a-communication-coverage-export"},{"openapi":"get /admin/mailings/exports/{uploadId}","title":"Download a generated mailing export","href":"/api-reference/communications/download-a-generated-mailing-export"},{"openapi":"get /admin/mailing_runs/{id}/download-zip","title":"Download a mailing run ZIP","href":"/api-reference/communications/download-a-mailing-run-zip"},{"openapi":"post /admin/mailing_templates/{id}/duplicate","title":"Duplicate a custom mailing template","href":"/api-reference/communications/duplicate-a-custom-mailing-template"},{"openapi":"patch /admin/message/draft/{email_id}/edit","title":"Edit a draft donor message","href":"/api-reference/communications/edit-a-draft-donor-message"},{"openapi":"put /admin/notes/{note_id}/{program_id}","title":"Edit a note","href":"/api-reference/communications/edit-a-note"},{"openapi":"put /admin/auto_emails/emailset","title":"Edit an email set","href":"/api-reference/communications/edit-an-email-set"},{"openapi":"put /admin/auto_emails/template","title":"Edit an email template","href":"/api-reference/communications/edit-an-email-template"},{"openapi":"patch /admin/newsLetters/{id}/edit","title":"Edit newsletter content or scheduling","href":"/api-reference/communications/edit-newsletter-content-or-scheduling"},{"openapi":"get /admin/auto_emails/template/{emailset_id}/{trigger}","title":"Email template Details","href":"/api-reference/communications/email-template-details"},{"openapi":"get /admin/notes/{type}/{id}/export","title":"Export notes as PDF","href":"/api-reference/communications/export-notes-as-pdf"},{"openapi":"get /admin/donors/by-tag","title":"Find newsletter donors by tag","href":"/api-reference/communications/find-newsletter-donors-by-tag"},{"openapi":"post /admin/mailing_templates/{id}/generate","title":"Generate a mailing run","href":"/api-reference/communications/generate-a-mailing-run"},{"openapi":"get /notes/{id}","title":"Get a specific note","href":"/api-reference/communications/get-a-specific-note"},{"openapi":"get /admin/email_manager/admins","title":"Get all admins","href":"/api-reference/communications/get-all-admins"},{"openapi":"get /notes","title":"Get all notes for an entity or donor","href":"/api-reference/communications/get-all-notes-for-an-entity-or-donor"},{"openapi":"get /admin/email_manager/entities","title":"Get available entities","href":"/api-reference/communications/get-available-entities"},{"openapi":"get /notes/categories","title":"Get available note categories","href":"/api-reference/communications/get-available-note-categories"},{"openapi":"get /admin/auto_emails/emailset/{emailset_id}","title":"Get details of an emailset","href":"/api-reference/communications/get-details-of-an-emailset"},{"openapi":"post /admin/email_manager/stats","title":"Get email category statistics","href":"/api-reference/communications/get-email-category-statistics"},{"openapi":"get /admin/notes/{note_id}/{program_id}","title":"Get note details","href":"/api-reference/communications/get-note-details"},{"openapi":"get /admin/email_manager/entities/{id}/sponsors","title":"Get sponsors of an entity","href":"/api-reference/communications/get-sponsors-of-an-entity"},{"openapi":"post /admin/email_manager/filter_names","title":"Get unique donor or entity names for email filtering","href":"/api-reference/communications/get-unique-donor-or-entity-names-for-email-filtering"},{"openapi":"post /admin/sms_inbox/conversations/{conversation_id}/link-donor","title":"Link an SMS conversation to a donor","href":"/api-reference/communications/link-an-sms-conversation-to-a-donor"},{"openapi":"get /activities/{id}/attachments","title":"List attachments on an email activity","href":"/api-reference/communications/list-attachments-on-an-email-activity"},{"openapi":"get /admin/auto_sms","title":"List automated SMS sets","href":"/api-reference/communications/list-automated-sms-sets"},{"openapi":"get /admin/mailings","title":"List generated mailings","href":"/api-reference/communications/list-generated-mailings"},{"openapi":"get /admin/mailing_templates","title":"List mailing templates","href":"/api-reference/communications/list-mailing-templates"},{"openapi":"get /admin/mailing_design_assets/{assetType}","title":"List mailing visual design assets","href":"/api-reference/communications/list-mailing-visual-design-assets"},{"openapi":"post /admin/newsLetters","title":"List newsletters with delivery summaries","href":"/api-reference/communications/list-newsletters-with-delivery-summaries"},{"openapi":"get /admin/notes/categories/{type}/{program_id}","title":"List note category names","href":"/api-reference/communications/list-note-category-names"},{"openapi":"get /admin/email/settings/sending-domains","title":"List organization email sending domains","href":"/api-reference/communications/list-organization-email-sending-domains"},{"openapi":"get /admin/sendblue/lines","title":"List organization Sendblue lines","href":"/api-reference/communications/list-organization-sendblue-lines"},{"openapi":"get /admin/mailing_runs","title":"List recent mailing runs","href":"/api-reference/communications/list-recent-mailing-runs"},{"openapi":"get /admin/recipient-messages","title":"List recipient messages for moderation","href":"/api-reference/communications/list-recipient-messages-for-moderation"},{"openapi":"get /admin/sms_inbox/conversations","title":"List SMS inbox conversations","href":"/api-reference/communications/list-sms-inbox-conversations"},{"openapi":"post /admin/donors/{donor_id}/mailings","title":"Log a donor mailing manually","href":"/api-reference/communications/log-a-donor-mailing-manually"},{"openapi":"get /admin/auto_emails","title":"Manage auto emails","href":"/api-reference/communications/manage-auto-emails"},{"openapi":"patch /activities/{id}/associate-donor","title":"Manually associate an email activity with a donor","href":"/api-reference/communications/manually-associate-an-email-activity-with-a-donor"},{"openapi":"post /admin/sms_inbox/conversations/{conversation_id}/mark-read","title":"Mark an SMS conversation read","href":"/api-reference/communications/mark-an-sms-conversation-read"},{"openapi":"put /admin/email/mark_read/{email_id}","title":"Mark email as read","href":"/api-reference/communications/mark-email-as-read"},{"openapi":"get /admin/newsLetters/{id}/recipients","title":"Page saved newsletter recipients","href":"/api-reference/communications/page-saved-newsletter-recipients"},{"openapi":"post /admin/template","title":"Post Template","href":"/api-reference/communications/post-template"},{"openapi":"post /admin/mailing_templates/{id}/preview","title":"Preview a mailing PDF","href":"/api-reference/communications/preview-a-mailing-pdf"},{"openapi":"get /admin/auto_emails/template/{emailset_id}/{trigger}/preview","title":"Preview persisted auto-email content","href":"/api-reference/communications/preview-persisted-auto-email-content"},{"openapi":"post /unsubscribe/preview","title":"Preview signed email preferences","href":"/api-reference/communications/preview-signed-email-preferences"},{"openapi":"post /admin/test_smsset","title":"Queue a commitment-based SMS test or live send","href":"/api-reference/communications/queue-a-commitment-based-sms-test-or-live-send"},{"openapi":"post /admin/communications/coverage/export","title":"Queue a communication coverage CSV export","href":"/api-reference/communications/queue-a-communication-coverage-csv-export"},{"openapi":"post /admin/mailings/bulk-export","title":"Queue a generated mailing ZIP export","href":"/api-reference/communications/queue-a-generated-mailing-zip-export"},{"openapi":"post /admin/sms_inbox/conversations/{conversation_id}/messages","title":"Queue a manual SMS reply","href":"/api-reference/communications/queue-a-manual-sms-reply"},{"openapi":"get /admin/auto_sms/send/{program_id}/{trigger}/{to}","title":"Queue an automated SMS trigger","href":"/api-reference/communications/queue-an-automated-sms-trigger"},{"openapi":"get /admin/auto_sms/send/{program_id}/{trigger}/{to}/{donor_id}","title":"Queue an automated SMS trigger","href":"/api-reference/communications/queue-an-automated-sms-trigger-1"},{"openapi":"get /admin/auto_sms/send/{program_id}/{trigger}/{to}/{donor_id}/{entity_id}","title":"Queue an automated SMS trigger","href":"/api-reference/communications/queue-an-automated-sms-trigger-2"},{"openapi":"get /admin/mailings/{id}","title":"Read a generated mailing","href":"/api-reference/communications/read-a-generated-mailing"},{"openapi":"get /admin/mailings/exports/{uploadId}/status","title":"Read a generated mailing export status","href":"/api-reference/communications/read-a-generated-mailing-export-status"},{"openapi":"get /admin/mailings/{id}/artifact/{kind}","title":"Read a generated mailing PDF","href":"/api-reference/communications/read-a-generated-mailing-pdf"},{"openapi":"get /admin/mailing_runs/{id}/artifact/{kind}","title":"Read a mailing run label sheet","href":"/api-reference/communications/read-a-mailing-run-label-sheet"},{"openapi":"get /admin/mailing_runs/{id}","title":"Read a mailing run progress","href":"/api-reference/communications/read-a-mailing-run-progress"},{"openapi":"get /admin/mailing_templates/{id}","title":"Read a mailing template editor","href":"/api-reference/communications/read-a-mailing-template-editor"},{"openapi":"get /admin/newsLetters/{id}","title":"Read a newsletter and audience snapshot","href":"/api-reference/communications/read-a-newsletter-and-audience-snapshot"},{"openapi":"get /admin/newsLetters/timing-recommendation","title":"Read a newsletter send-time recommendation","href":"/api-reference/communications/read-a-newsletter-send-time-recommendation"},{"openapi":"get /admin/recipient-messages/{id}","title":"Read a recipient message mailbox detail","href":"/api-reference/communications/read-a-recipient-message-mailbox-detail"},{"openapi":"get /admin/auto_sms/smsset/{smsset_id}","title":"Read an automated SMS set","href":"/api-reference/communications/read-an-automated-sms-set"},{"openapi":"get /admin/auto_sms/template/{smsset_id}/{trigger}","title":"Read an automated SMS template editor","href":"/api-reference/communications/read-an-automated-sms-template-editor"},{"openapi":"get /admin/sms_inbox/conversations/{conversation_id}","title":"Read an SMS conversation","href":"/api-reference/communications/read-an-sms-conversation"},{"openapi":"get /admin/communications/coverage/exports/{exportId}/status","title":"Read communication coverage export status","href":"/api-reference/communications/read-communication-coverage-export-status"},{"openapi":"get /admin/communications/coverage/targets/{coverageTargetId}","title":"Read communication coverage target history","href":"/api-reference/communications/read-communication-coverage-target-history"},{"openapi":"get /admin/communications/coverage/summary","title":"Read communication coverage totals","href":"/api-reference/communications/read-communication-coverage-totals"},{"openapi":"get /donor/{id}/communication-preferences","title":"Read donor communication preferences","href":"/api-reference/communications/read-donor-communication-preferences"},{"openapi":"get /admin/donors/{donor_id}/mailings","title":"Read donor mailing activity","href":"/api-reference/communications/read-donor-mailing-activity"},{"openapi":"get /frontend/donor/dashboard/notification-preferences/{client_id}/{program_id}/{session_id}","title":"Read donor portal notification preferences","href":"/api-reference/communications/read-donor-portal-notification-preferences"},{"openapi":"get /admin/mailing_templates/meta/options","title":"Read mailing template merge options","href":"/api-reference/communications/read-mailing-template-merge-options"},{"openapi":"get /admin/newsLetters/composer-metadata","title":"Read newsletter composer merge tags","href":"/api-reference/communications/read-newsletter-composer-merge-tags"},{"openapi":"get /admin/newsLetters/{id}/delivery-results","title":"Read per-recipient newsletter delivery results","href":"/api-reference/communications/read-per-recipient-newsletter-delivery-results"},{"openapi":"post /admin/email/settings/sending-domains/{domainId}/reconcile","title":"Reconcile email sending domain provisioning","href":"/api-reference/communications/reconcile-email-sending-domain-provisioning"},{"openapi":"patch /admin/mailings/delivery-status","title":"Record mailing delivery statuses","href":"/api-reference/communications/record-mailing-delivery-statuses"},{"openapi":"post /admin/newsLetters/{id}/audience/refresh","title":"Refresh a saved tag newsletter audience","href":"/api-reference/communications/refresh-a-saved-tag-newsletter-audience"},{"openapi":"post /admin/recipient-messages/{id}/reject","title":"Reject a pending recipient message","href":"/api-reference/communications/reject-a-pending-recipient-message"},{"openapi":"delete /admin/auto_sms/smsset/{smsset_id}","title":"Remove an automated SMS set","href":"/api-reference/communications/remove-an-automated-sms-set"},{"openapi":"delete /admin/auto_emails/emailset/{emailset_id}","title":"Remove an email set","href":"/api-reference/communications/remove-an-email-set"},{"openapi":"delete /admin/email/settings/sending-domains/{domainId}","title":"Remove an inactive sending domain","href":"/api-reference/communications/remove-an-inactive-sending-domain"},{"openapi":"put /admin/notes/categories/{category_id}","title":"Rename a profile-note category","href":"/api-reference/communications/rename-a-profile-note-category"},{"openapi":"get /admin/message-context","title":"Resolve donor and recipient message context","href":"/api-reference/communications/resolve-donor-and-recipient-message-context"},{"openapi":"get /admin/template","title":"Retrieve Template","href":"/api-reference/communications/retrieve-template"},{"openapi":"post /admin/newsLetters/{id}/retry","title":"Retry failed newsletter deliveries","href":"/api-reference/communications/retry-failed-newsletter-deliveries"},{"openapi":"put /admin/auto_sms/template","title":"Save an automated SMS template","href":"/api-reference/communications/save-an-automated-sms-template"},{"openapi":"post /admin/save/recipients","title":"Save newsletter content and audience","href":"/api-reference/communications/save-newsletter-content-and-audience"},{"openapi":"post /unsubscribe","title":"Save preferences from a signed email link","href":"/api-reference/communications/save-preferences-from-a-signed-email-link"},{"openapi":"get /admin/auto_sms/template/{smsset_id}/{trigger}/sponsorships","title":"Search automated SMS commitment preview options","href":"/api-reference/communications/search-automated-sms-commitment-preview-options"},{"openapi":"get /admin/auto_emails/template/{emailset_id}/{trigger}/sponsorships","title":"Search commitment preview options","href":"/api-reference/communications/search-commitment-preview-options"},{"openapi":"post /admin/communications/coverage/rollups/search","title":"Search communication coverage rollups","href":"/api-reference/communications/search-communication-coverage-rollups"},{"openapi":"post /admin/communications/coverage/targets/search","title":"Search communication coverage targets","href":"/api-reference/communications/search-communication-coverage-targets"},{"openapi":"post /admin/email_manager/search","title":"Search emails using Meilisearch","href":"/api-reference/communications/search-emails-using-meilisearch"},{"openapi":"get /admin/message/send/{entity_id}/{donor_id}/{from}/{file_id}","title":"Send a message","href":"/api-reference/communications/send-a-message"},{"openapi":"post /admin/message/send/{entity_id}/{from}/{file_id}","title":"Send a message","href":"/api-reference/communications/send-a-message-1"},{"openapi":"post /admin/auto_emails/send/{program_id}/profile_update/donor/{donor_id}/{entity_id}","title":"Send a recipient profile-update email","href":"/api-reference/communications/send-a-recipient-profile-update-email"},{"openapi":"post /admin/test_emailset","title":"Send a test automated email","href":"/api-reference/communications/send-a-test-automated-email"},{"openapi":"post /admin/email/settings/sending-domains/{domainId}/test","title":"Send a verified-domain test email","href":"/api-reference/communications/send-a-verified-domain-test-email"},{"openapi":"get /admin/auto_emails/send/{program_id}/{trigger}/{to}/{donor_id}/{entity_id}","title":"Send an email","href":"/api-reference/communications/send-an-email"},{"openapi":"post /admin/email/response","title":"Send an email response","href":"/api-reference/communications/send-an-email-response"},{"openapi":"post /admin/send/newsLetter/{id}/send","title":"Send an existing newsletter now","href":"/api-reference/communications/send-an-existing-newsletter-now"},{"openapi":"post /admin/sms_inbox/conversations/start","title":"Start or reuse a donor SMS conversation","href":"/api-reference/communications/start-or-reuse-a-donor-sms-conversation"},{"openapi":"post /admin/email/settings/sending-domains","title":"Start verified email domain setup","href":"/api-reference/communications/start-verified-email-domain-setup"},{"openapi":"post /admin/sendblue/lines/sync","title":"Synchronize organization Sendblue lines","href":"/api-reference/communications/synchronize-organization-sendblue-lines"},{"openapi":"put /admin/mailing_templates/{id}","title":"Update a custom mailing template","href":"/api-reference/communications/update-a-custom-mailing-template"},{"openapi":"put /notes/{id}","title":"Update a note","href":"/api-reference/communications/update-a-note"},{"openapi":"put /admin/auto_sms/smsset","title":"Update an automated SMS set","href":"/api-reference/communications/update-an-automated-sms-set"},{"openapi":"patch /donor/{id}/communication-preferences","title":"Update donor communication preferences","href":"/api-reference/communications/update-donor-communication-preferences"},{"openapi":"put /frontend/donor/dashboard/notification-preferences/{client_id}/{program_id}/{session_id}","title":"Update donor portal notification preferences","href":"/api-reference/communications/update-donor-portal-notification-preferences"},{"openapi":"put /admin/email/status/{email_id}/update","title":"Update the status of an email","href":"/api-reference/communications/update-the-status-of-an-email"},{"openapi":"put /admin/emails/status/{mail_status}/update","title":"Update the status of multiple emails","href":"/api-reference/communications/update-the-status-of-multiple-emails"},{"openapi":"post /admin/sms_inbox/attachments","title":"Upload a pending SMS attachment","href":"/api-reference/communications/upload-a-pending-sms-attachment"},{"openapi":"post /admin/upload_pic_to_template","title":"Upload a template image","href":"/api-reference/communications/upload-a-template-image"},{"openapi":"get /admin/auto_email_s3_upload","title":"Upload an auto-email editor image to S3","href":"/api-reference/communications/upload-an-auto-email-editor-image-to-s3"},{"openapi":"get /admin/emails/{email_id}","title":"View a specific email","href":"/api-reference/communications/view-a-specific-email"},{"openapi":"post /admin/email_manager/admin/{id}/emails","title":"View all admin emails","href":"/api-reference/communications/view-all-admin-emails"},{"openapi":"post /admin/email_manager","title":"View email manager","href":"/api-reference/communications/view-email-manager"},{"openapi":"post /admin/notes","title":"View notes","href":"/api-reference/communications/view-notes"}]},{"group":"Donations","pages":[{"openapi":"post /admin/commitment/{commitment_id}/donation","title":"Add a commitment donation","href":"/api-reference/donations/add-a-commitment-donation"},{"openapi":"post /admin/designation","title":"Add a new designation","href":"/api-reference/donations/add-a-new-designation"},{"openapi":"post /admin/donation","title":"Add a new donation","href":"/api-reference/donations/add-a-new-donation"},{"openapi":"post /admin/donations/{donation_id}/soft-credits","title":"Add manual donation recognition credits","href":"/api-reference/donations/add-manual-donation-recognition-credits"},{"openapi":"post /admin/add_cc","title":"Attach a credit card to a donor on the active gateway","href":"/api-reference/donations/attach-a-credit-card-to-a-donor-on-the-active-gateway"},{"openapi":"get /admin/commitment/{commitment_id}/donation","title":"Ccommitment details","href":"/api-reference/donations/ccommitment-details"},{"openapi":"patch /admin/donors/{donorId}/giving-institution","title":"Change an organization giving-institution role","href":"/api-reference/donations/change-an-organization-giving-institution-role"},{"openapi":"get /admin/donors/{donor_id}/all-credits","title":"Combined hard- and soft-credit transaction history for a donor","href":"/api-reference/donations/combined-hard-and-soft-credit-transaction-history-for-a-donor"},{"openapi":"post /admin/donation-fields","title":"Create a custom donation field","href":"/api-reference/donations/create-a-custom-donation-field"},{"openapi":"post /admin/donors/{hysform_id}/giving-institutions","title":"Create, link, or convert a giving institution","href":"/api-reference/donations/create-link-or-convert-a-giving-institution"},{"openapi":"delete /admin/reports/schedule/{id}","title":"Delete a scheduled report (and its filter preference)","href":"/api-reference/donations/delete-a-scheduled-report-and-its-filter-preference"},{"openapi":"get /admin/designation/{designation_id}","title":"Designation Details","href":"/api-reference/donations/designation-details"},{"openapi":"get /admin/donations/statistics","title":"Donation count + amount roll-up for a date window","href":"/api-reference/donations/donation-count-+-amount-roll-up-for-a-date-window"},{"openapi":"get /admin/donation/{donation_id}","title":"Donation details","href":"/api-reference/donations/donation-details"},{"openapi":"get /admin/donations/options","title":"Donation view options","href":"/api-reference/donations/donation-view-options"},{"openapi":"get /admin/donations/exports/{uploadId}","title":"Download a finished donation/soft-credit export","href":"/api-reference/donations/download-a-finished-donationsoft-credit-export"},{"openapi":"get /admin/commitments/{commitment_id}","title":"Edit a commitment","href":"/api-reference/donations/edit-a-commitment"},{"openapi":"put /admin/commitments/{commitment_id}","title":"Edit a commitment","href":"/api-reference/donations/edit-a-commitment-1"},{"openapi":"put /admin/designation/{designation_id}","title":"Edit a designation","href":"/api-reference/donations/edit-a-designation"},{"openapi":"put /admin/donation/{donation_id}","title":"Edit a donation","href":"/api-reference/donations/edit-a-donation"},{"openapi":"patch /admin/commitments","title":"Edit multiple commitments","href":"/api-reference/donations/edit-multiple-commitments"},{"openapi":"post /admin/donors/send_tax_summary","title":"Email tax summaries (selected donors or admin recipients)","href":"/api-reference/donations/email-tax-summaries-selected-donors-or-admin-recipients"},{"openapi":"post /admin/households/send_year_end","title":"Email year-end statements to households","href":"/api-reference/donations/email-year-end-statements-to-households"},{"openapi":"get /admin/donation-reports/{id}","title":"Fetch a single saved report definition","href":"/api-reference/donations/fetch-a-single-saved-report-definition"},{"openapi":"get /admin/donations/giving-people","title":"Find giving-source people and advisors","href":"/api-reference/donations/find-giving-source-people-and-advisors"},{"openapi":"get /admin/donations","title":"Get a donation worksheet with query filters","href":"/api-reference/donations/get-a-donation-worksheet-with-query-filters"},{"openapi":"get /admin/donations/{donation_id}/soft-credits","title":"Get a donation’s recognition credits","href":"/api-reference/donations/get-a-donation’s-recognition-credits"},{"openapi":"get /admin/donors/{donor_id}/donations","title":"Get all donations by a specific donor","href":"/api-reference/donations/get-all-donations-by-a-specific-donor"},{"openapi":"get /admin/donors/donations","title":"Get all donations by donors","href":"/api-reference/donations/get-all-donations-by-donors"},{"openapi":"get /commitments/{date_from}/{date_to}/graph","title":"Get commitments graph","href":"/api-reference/donations/get-commitments-graph"},{"openapi":"get /donations/{date_from}/{date_to}/graph","title":"Get donations graph","href":"/api-reference/donations/get-donations-graph"},{"openapi":"get /admin/form/{donor_group}/fields","title":"Get form fields for a specific donor group","href":"/api-reference/donations/get-form-fields-for-a-specific-donor-group"},{"openapi":"get /admin/add_cc","title":"Init the legacy add-credit-card form","href":"/api-reference/donations/init-the-legacy-add-credit-card-form"},{"openapi":"get /admin/donations/coverage-options","title":"List a donor’s sponsorship coverage options","href":"/api-reference/donations/list-a-donor’s-sponsorship-coverage-options"},{"openapi":"get /admin/donation-fields","title":"List custom donation field definitions","href":"/api-reference/donations/list-custom-donation-field-definitions"},{"openapi":"get /admin/donations/exports/active","title":"List donation/soft-credit export jobs currently queued or processing","href":"/api-reference/donations/list-donationsoft-credit-export-jobs-currently-queued-or-processing"},{"openapi":"get /admin/designation","title":"List emailsets and program forms when creating a designation","href":"/api-reference/donations/list-emailsets-and-program-forms-when-creating-a-designation"},{"openapi":"get /admin/soft-credits","title":"List organization recognition credits","href":"/api-reference/donations/list-organization-recognition-credits"},{"openapi":"get /admin/donors/donation_years","title":"List the distinct years that have donation activity","href":"/api-reference/donations/list-the-distinct-years-that-have-donation-activity"},{"openapi":"put /admin/reports/schedule/{id}","title":"Patch a scheduled report's cadence or recipients","href":"/api-reference/donations/patch-a-scheduled-reports-cadence-or-recipients"},{"openapi":"get /admin/donations/exports/{uploadId}/status","title":"Poll a single donation/soft-credit export","href":"/api-reference/donations/poll-a-single-donationsoft-credit-export"},{"openapi":"get /admin/donations/updated-feed","title":"Poll donations that were updated after creation","href":"/api-reference/donations/poll-donations-that-were-updated-after-creation"},{"openapi":"post /admin/commitment/{commitment_id}/donation/receipt-preview","title":"Preview a commitment payment receipt","href":"/api-reference/donations/preview-a-commitment-payment-receipt"},{"openapi":"post /admin/donations/receipt-preview","title":"Preview a staff-entered donation receipt","href":"/api-reference/donations/preview-a-staff-entered-donation-receipt"},{"openapi":"post /admin/donations/giving-preview","title":"Preview gift ownership and sponsorship coverage","href":"/api-reference/donations/preview-gift-ownership-and-sponsorship-coverage"},{"openapi":"get /admin/export_donations","title":"Queue a CSV export of donations or soft credits (async)","href":"/api-reference/donations/queue-a-csv-export-of-donations-or-soft-credits-async"},{"openapi":"get /admin/export_donor_donations","title":"Queue a single donor's donation history export","href":"/api-reference/donations/queue-a-single-donors-donation-history-export"},{"openapi":"get /admin/tax-summaries/donors/{donor_id}","title":"Read a donor tax-summary contribution projection","href":"/api-reference/donations/read-a-donor-tax-summary-contribution-projection"},{"openapi":"get /admin/tax-summaries/households/{household_id}","title":"Read a household tax-summary contribution projection","href":"/api-reference/donations/read-a-household-tax-summary-contribution-projection"},{"openapi":"get /admin/donors/{donor_id}/custodian-activity","title":"Read an institution historical QCD custody activity","href":"/api-reference/donations/read-an-institution-historical-qcd-custody-activity"},{"openapi":"get /admin/donations/{donation_id}/refresh","title":"Refresh donation status from Stripe","href":"/api-reference/donations/refresh-donation-status-from-stripe"},{"openapi":"post /admin/donation/{donation_id}/refund","title":"Refund a donation","href":"/api-reference/donations/refund-a-donation"},{"openapi":"delete /admin/designation/{designation_id}","title":"Remove a designation","href":"/api-reference/donations/remove-a-designation"},{"openapi":"delete /admin/donation/{donation_id}","title":"Remove a donation","href":"/api-reference/donations/remove-a-donation"},{"openapi":"get /admin/delete_cc","title":"Remove a donor card on the active gateway","href":"/api-reference/donations/remove-a-donor-card-on-the-active-gateway"},{"openapi":"delete /admin/donations/{donation_id}/soft-credits/{id}","title":"Remove a manual recognition credit","href":"/api-reference/donations/remove-a-manual-recognition-credit"},{"openapi":"put /admin/donation-fields/order","title":"Reorder custom donation fields","href":"/api-reference/donations/reorder-custom-donation-fields"},{"openapi":"get /admin/commitment/fix","title":"Repair a sponsorship missing its commitment record","href":"/api-reference/donations/repair-a-sponsorship-missing-its-commitment-record"},{"openapi":"post /admin/reports/schedule","title":"Schedule a saved report for recurring delivery","href":"/api-reference/donations/schedule-a-saved-report-for-recurring-delivery"},{"openapi":"get /admin/donations/designations/search","title":"Search donation designation recipients","href":"/api-reference/donations/search-donation-designation-recipients"},{"openapi":"get /admin/donations/giving-institutions","title":"Search giving institutions and the starter directory","href":"/api-reference/donations/search-giving-institutions-and-the-starter-directory"},{"openapi":"delete /admin/commitments","title":"Soft-delete a single commitment by id","href":"/api-reference/donations/soft-delete-a-single-commitment-by-id"},{"openapi":"get /admin/donations/daf-fund-names","title":"Suggest previously disclosed DAF fund names","href":"/api-reference/donations/suggest-previously-disclosed-daf-fund-names"},{"openapi":"get /admin/10_commitments","title":"Top 10 most recent commitments (dashboard widget)","href":"/api-reference/donations/top-10-most-recent-commitments-dashboard-widget"},{"openapi":"put /admin/donation-fields/{fieldId}","title":"Update a custom donation field","href":"/api-reference/donations/update-a-custom-donation-field"},{"openapi":"put /admin/donations/{donation_id}/soft-credits/{id}","title":"Update a manual recognition credit","href":"/api-reference/donations/update-a-manual-recognition-credit"},{"openapi":"post /admin/update_cc","title":"Update an existing donor card on the active gateway","href":"/api-reference/donations/update-an-existing-donor-card-on-the-active-gateway"},{"openapi":"get /admin/designations","title":"View all designations","href":"/api-reference/donations/view-all-designations"},{"openapi":"post /admin/donations/{all}","title":"View all donations","href":"/api-reference/donations/view-all-donations"}]},{"group":"Donor Portal","pages":[{"openapi":"post /frontend/donor/dashboard/{client_id}/{program_id}/{session_id}","title":"Add a one-time donation from the donor dashboard","href":"/api-reference/donor-portal/add-a-one-time-donation-from-the-donor-dashboard"},{"openapi":"post /frontend/modify_amount","title":"Apply a modify-commitment-amount change","href":"/api-reference/donor-portal/apply-a-modify-commitment-amount-change"},{"openapi":"post /frontend/donor/dashboard/approve_paypal/{client_id}/{program_id}/{session_id}","title":"Approve a PayPal payment from the donor dashboard","href":"/api-reference/donor-portal/approve-a-paypal-payment-from-the-donor-dashboard"},{"openapi":"post /frontend/donor/dashboard/bank-verification/{client_id}/{program_id}/{session_id}","title":"Check donor bank verification completion","href":"/api-reference/donor-portal/check-donor-bank-verification-completion"},{"openapi":"put /frontend/donor/dashboard/card-verify/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Continue 3DS card verification","href":"/api-reference/donor-portal/continue-3ds-card-verification"},{"openapi":"delete /frontend/donor/dashboard/file/{client_id}/{program_id}/{id}/{entity_id}/{session_id}","title":"Delete a file","href":"/api-reference/donor-portal/delete-a-file"},{"openapi":"get /frontend/donor/dashboard/card/{client_id}/{program_id}/{session_id}","title":"Donor Credit Card Information","href":"/api-reference/donor-portal/donor-credit-card-information"},{"openapi":"get /frontend/donor/dashboard/{client_id}/{program_id}/{session_id}","title":"Donor View","href":"/api-reference/donor-portal/donor-view"},{"openapi":"get /frontend/donor/dashboard/entity/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Donor View Entity","href":"/api-reference/donor-portal/donor-view-entity"},{"openapi":"get /frontend/donor/dashboard/entity/messages/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Donor View Entity Message History","href":"/api-reference/donor-portal/donor-view-entity-message-history"},{"openapi":"get /frontend/forgot_username/{client_id}/{program_id}/{session_id}","title":"Forgot Username","href":"/api-reference/donor-portal/forgot-username"},{"openapi":"get /frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id}","title":"Get Donor Information","href":"/api-reference/donor-portal/get-donor-information"},{"openapi":"get /frontend/donor/dashboard/files/{client_id}/{program_id}/{id}/{entity_id}/{session_id}","title":"Get files for a donor","href":"/api-reference/donor-portal/get-files-for-a-donor"},{"openapi":"get /frontend/login/{client_id}/{program_id}/{session_id}","title":"Get Login Information","href":"/api-reference/donor-portal/get-login-information"},{"openapi":"get /donor/paypal","title":"Get PayPal credentials","href":"/api-reference/donor-portal/get-paypal-credentials"},{"openapi":"get /frontend/donor/dashboard/uploads/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Handle Donor File Uploads","href":"/api-reference/donor-portal/handle-donor-file-uploads"},{"openapi":"get /frontend/donor/dashboard/donation-designations/{client_id}/{program_id}/{session_id}","title":"List eligible one-time donation designations","href":"/api-reference/donor-portal/list-eligible-one-time-donation-designations"},{"openapi":"post /frontend/global_donor/login","title":"Log in a donor across organizations","href":"/api-reference/donor-portal/log-in-a-donor-across-organizations"},{"openapi":"put /frontend/donor/dashboard/entity/mark_read/{client_id}/{program_id}/{entity_id}/{email_id}/{session_id}","title":"Mark email as read","href":"/api-reference/donor-portal/mark-email-as-read"},{"openapi":"post /frontend/donor/dashboard/entity/compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id}","title":"Post Donor View Entity Message","href":"/api-reference/donor-portal/post-donor-view-entity-message"},{"openapi":"post /frontend/forgot_username/{client_id}/{program_id}/{session_id}","title":"Post Forgot Username","href":"/api-reference/donor-portal/post-forgot-username"},{"openapi":"post /frontend/login/{client_id}/{program_id}/{session_id}","title":"Post Login","href":"/api-reference/donor-portal/post-login"},{"openapi":"get /frontend/logout/{client_id}/{program_id}/{session_id}","title":"Post Logout","href":"/api-reference/donor-portal/post-logout"},{"openapi":"post /frontend/reset_password/{client_id}/{program_id}/{session_id}","title":"Post Reset Password","href":"/api-reference/donor-portal/post-reset-password"},{"openapi":"delete /frontend/donor/dashboard/card/{client_id}/{program_id}/{session_id}","title":"Remove a saved donor payment method","href":"/api-reference/donor-portal/remove-a-saved-donor-payment-method"},{"openapi":"get /frontend/donor_view_entity_compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id}","title":"Render compose-message-to-entity page payload","href":"/api-reference/donor-portal/render-compose-message-to-entity-page-payload"},{"openapi":"get /frontend/modify_amount","title":"Render modify-commitment-amount page payload","href":"/api-reference/donor-portal/render-modify-commitment-amount-page-payload"},{"openapi":"post /frontend/global_donor/passwordless_login","title":"Request a global donor passwordless sign-in","href":"/api-reference/donor-portal/request-a-global-donor-passwordless-sign-in"},{"openapi":"get /frontend/reset_password/{client_id}/{program_id}/{session_id}","title":"Reset Password","href":"/api-reference/donor-portal/reset-password"},{"openapi":"get /frontend/get_forms/{type}/{id}/{hysform_id}/{client_id}","title":"Resolve forms attached to a donor or entity","href":"/api-reference/donor-portal/resolve-forms-attached-to-a-donor-or-entity"},{"openapi":"get /frontend/donor/dashboard/card-verify/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Retrieve 3DS card verification state","href":"/api-reference/donor-portal/retrieve-3ds-card-verification-state"},{"openapi":"post /frontend/donor/recordUpload/{client_id}/{session_id}","title":"Save file upload to database","href":"/api-reference/donor-portal/save-file-upload-to-database"},{"openapi":"post /frontend/global_donor/select_account","title":"Select a global donor account","href":"/api-reference/donor-portal/select-a-global-donor-account"},{"openapi":"post /frontend/passwordless_login/{client_id}/{program_id}/{session_id}","title":"Start Email Sign-In","href":"/api-reference/donor-portal/start-email-sign-in"},{"openapi":"put /frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id}","title":"Update Donor Information","href":"/api-reference/donor-portal/update-donor-information"},{"openapi":"post /donor/{donor_id}/paypal","title":"Update donor PayPal credentials","href":"/api-reference/donor-portal/update-donor-paypal-credentials"},{"openapi":"post /frontend/donor/dashboard/card/{client_id}/{program_id}/{session_id}","title":"Update Donor's Credit Card Information","href":"/api-reference/donor-portal/update-donors-credit-card-information"},{"openapi":"post /frontend/donor/dashboard/paypal/{client_id}/{program_id}/{session_id}","title":"Update the donor's PayPal email","href":"/api-reference/donor-portal/update-the-donors-paypal-email"},{"openapi":"post /frontend/donor/dashboard/upload/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Uploads a file for a donor","href":"/api-reference/donor-portal/uploads-a-file-for-a-donor"},{"openapi":"get /frontend/global_donor/passwordless_verify/{token}","title":"Verify a global donor magic link","href":"/api-reference/donor-portal/verify-a-global-donor-magic-link"},{"openapi":"post /frontend/global_donor/passwordless_verify_code","title":"Verify a global donor passwordless code","href":"/api-reference/donor-portal/verify-a-global-donor-passwordless-code"},{"openapi":"get /frontend/passwordless_verify/{client_id}/{program_id}/{token}","title":"Verify Email Sign-In","href":"/api-reference/donor-portal/verify-email-sign-in"},{"openapi":"post /frontend/passwordless_verify_code/{client_id}/{program_id}","title":"Verify the donor passwordless verification code","href":"/api-reference/donor-portal/verify-the-donor-passwordless-verification-code"},{"openapi":"get /frontend/view_forms/{archived_form_id}","title":"View an archived form submission","href":"/api-reference/donor-portal/view-an-archived-form-submission"}]},{"group":"Donor Signup","pages":[{"openapi":"post /frontend/signup_donor/{client_id}/{program_id}/{session_id}","title":"Add a new donor","href":"/api-reference/donor-signup/add-a-new-donor"},{"openapi":"get /frontend/signup_donor/{client_id}/{program_id}/{session_id}","title":"Sign up a new donor","href":"/api-reference/donor-signup/sign-up-a-new-donor"}]},{"group":"Donors","pages":[{"openapi":"post /admin/donors/activate","title":"Activate donors","href":"/api-reference/donors/activate-donors"},{"openapi":"post /admin/donor/{hysform_id}","title":"Add a new donor","href":"/api-reference/donors/add-a-new-donor"},{"openapi":"post /admin/households/{household_id}/donors","title":"Add multiple donors to a household","href":"/api-reference/donors/add-multiple-donors-to-a-household"},{"openapi":"post /admin/households/{household_id}/donors/{donor_id}","title":"Add one donor to a household","href":"/api-reference/donors/add-one-donor-to-a-household"},{"openapi":"get /admin/donor/archive","title":"Archive a single donor","href":"/api-reference/donors/archive-a-single-donor"},{"openapi":"post /admin/donors/archive","title":"Archive donors","href":"/api-reference/donors/archive-donors"},{"openapi":"patch /admin/donor/{donor_id}/assignment","title":"Assign or clear a donor relationship manager","href":"/api-reference/donors/assign-or-clear-a-donor-relationship-manager"},{"openapi":"patch /admin/donors/assignment","title":"Assign relationship managers to selected donors","href":"/api-reference/donors/assign-relationship-managers-to-selected-donors"},{"openapi":"patch /admin/program/donors","title":"Bulk-edit fields across many donors (async)","href":"/api-reference/donors/bulk-edit-fields-across-many-donors-async"},{"openapi":"post /admin/donors/{hysform_id}/footer-calculations","title":"Calculate donor worksheet footer totals","href":"/api-reference/donors/calculate-donor-worksheet-footer-totals"},{"openapi":"delete /admin/donors/default-saved-view","title":"Clear the default donor saved view","href":"/api-reference/donors/clear-the-default-donor-saved-view"},{"openapi":"delete /admin/saved-view-defaults/{module}","title":"Clear the default worksheet saved view","href":"/api-reference/donors/clear-the-default-worksheet-saved-view"},{"openapi":"post /admin/donors/filter-count","title":"Count donors matching worksheet filters","href":"/api-reference/donors/count-donors-matching-worksheet-filters"},{"openapi":"post /admin/households","title":"Create a household","href":"/api-reference/donors/create-a-household"},{"openapi":"post /admin/households/create-from-donor","title":"Create a household from two donor records","href":"/api-reference/donors/create-a-household-from-two-donor-records"},{"openapi":"delete /admin/donationFilter/saved_filters","title":"Delete a saved donation definition","href":"/api-reference/donors/delete-a-saved-donation-definition"},{"openapi":"delete /admin/households/{household_id}","title":"Delete an empty household","href":"/api-reference/donors/delete-an-empty-household"},{"openapi":"delete /admin/donor-credit-card/{donor_id}","title":"Delete donor card details","href":"/api-reference/donors/delete-donor-card-details"},{"openapi":"delete /admin/delete/donors","title":"Delete donors","href":"/api-reference/donors/delete-donors"},{"openapi":"delete /admin/donors/saved_filters","title":"Delete donors saved definition","href":"/api-reference/donors/delete-donors-saved-definition"},{"openapi":"delete /admin/entities/saved_filters","title":"Delete entities saved definition","href":"/api-reference/donors/delete-entities-saved-definition"},{"openapi":"delete /admin/files/saved_filters","title":"Delete files saved definition","href":"/api-reference/donors/delete-files-saved-definition"},{"openapi":"delete /admin/sponsorships/saved_filters","title":"Delete sponsorships saved definition","href":"/api-reference/donors/delete-sponsorships-saved-definition"},{"openapi":"post /admin/donors/duplicates/mark-not-duplicate","title":"Dismiss one duplicate donor pair","href":"/api-reference/donors/dismiss-one-duplicate-donor-pair"},{"openapi":"get /admin/donors/{hysform_id}/headers/{trashed}","title":"Donors table headers","href":"/api-reference/donors/donors-table-headers"},{"openapi":"get /admin/donors/exports/{uploadId}","title":"Download a finished donor export","href":"/api-reference/donors/download-a-finished-donor-export"},{"openapi":"patch /donor/{id}/edit","title":"Edit a donor","href":"/api-reference/donors/edit-a-donor"},{"openapi":"get /admin/donors/migrate-fields/options","title":"Field-mapping options for the migrate-fields tool","href":"/api-reference/donors/field-mapping-options-for-the-migrate-fields-tool"},{"openapi":"post /admin/all_donors/filter/{hysform_id}","title":"Filter donor worksheet rows","href":"/api-reference/donors/filter-donor-worksheet-rows"},{"openapi":"get /donor/{id}","title":"Get a donor","href":"/api-reference/donors/get-a-donor"},{"openapi":"get /donors/{donorId}/relationship-context","title":"Get a donor relationship schedule and history","href":"/api-reference/donors/get-a-donor-relationship-schedule-and-history"},{"openapi":"get /admin/all_donors","title":"Get all donors","href":"/api-reference/donors/get-all-donors"},{"openapi":"get /admin/donors/{hysform_id}","title":"Get all donors with pagination, search and sort","href":"/api-reference/donors/get-all-donors-with-pagination-search-and-sort"},{"openapi":"get /admin/donor-credit-card/{donor_id}","title":"Get donor card details","href":"/api-reference/donors/get-donor-card-details"},{"openapi":"get /admin/donor/{hysform_id}","title":"Get donor form fields","href":"/api-reference/donors/get-donor-form-fields"},{"openapi":"get /admin/donors/{hysform_id}/fields/{type}","title":"Get field options for donors","href":"/api-reference/donors/get-field-options-for-donors"},{"openapi":"get /admin/households/{household_id}","title":"Get household details","href":"/api-reference/donors/get-household-details"},{"openapi":"get /admin/donations/{hysform_id}/column-preferences","title":"Get personal donation worksheet columns","href":"/api-reference/donors/get-personal-donation-worksheet-columns"},{"openapi":"get /admin/donors/{hysform_id}/column-preferences","title":"Get personal donor worksheet columns","href":"/api-reference/donors/get-personal-donor-worksheet-columns"},{"openapi":"get /admin/sponsorships/{program_id}/column-preferences","title":"Get personal sponsorship worksheet columns","href":"/api-reference/donors/get-personal-sponsorship-worksheet-columns"},{"openapi":"get /admin/statistics/donors","title":"Get statistics of donors","href":"/api-reference/donors/get-statistics-of-donors"},{"openapi":"get /admin/donors/{hysform_id}/duplicates/rules","title":"Get the active duplicate-detection ruleset for a form","href":"/api-reference/donors/get-the-active-duplicate-detection-ruleset-for-a-form"},{"openapi":"get /admin/donors/default-saved-view","title":"Get the default donor saved view","href":"/api-reference/donors/get-the-default-donor-saved-view"},{"openapi":"get /admin/saved-view-defaults/{module}","title":"Get the default worksheet saved view","href":"/api-reference/donors/get-the-default-worksheet-saved-view"},{"openapi":"delete /admin/donor/delete","title":"Hard-delete a single archived donor","href":"/api-reference/donors/hard-delete-a-single-archived-donor"},{"openapi":"post /admin/donors/{hysform_id}/duplicates/{trashed}","title":"Kick off a legacy duplicate-detection scan (async)","href":"/api-reference/donors/kick-off-a-legacy-duplicate-detection-scan-async"},{"openapi":"post /admin/donors/{hysform_id}/duplicates/enhanced","title":"Kick off the rule-based duplicate scan (async)","href":"/api-reference/donors/kick-off-the-rule-based-duplicate-scan-async"},{"openapi":"post /admin/client-donor-update-sources","title":"Legacy donor payment-source refresh (disabled)","href":"/api-reference/donors/legacy-donor-payment-source-refresh-disabled"},{"openapi":"post /admin/donors/{donor_id}/relationships","title":"Link reciprocal donor contacts","href":"/api-reference/donors/link-reciprocal-donor-contacts"},{"openapi":"get /admin/households","title":"List active households","href":"/api-reference/donors/list-active-households"},{"openapi":"get /admin/show_all_donors/{client_id}/{hysform_id}/{trashed}","title":"List all donors for a form (legacy unpaginated table)","href":"/api-reference/donors/list-all-donors-for-a-form-legacy-unpaginated-table"},{"openapi":"get /admin/donationFilter/saved_filters/{hysform_id}","title":"List donation saved definitions","href":"/api-reference/donors/list-donation-saved-definitions"},{"openapi":"get /admin/donors/exports/active","title":"List donor-export jobs currently queued or processing","href":"/api-reference/donors/list-donor-export-jobs-currently-queued-or-processing"},{"openapi":"get /admin/donors/{donor_id}/relationships","title":"List donor household and external contacts","href":"/api-reference/donors/list-donor-household-and-external-contacts"},{"openapi":"get /admin/donors/saved_filters/{hysform_id}","title":"List donor saved definitions","href":"/api-reference/donors/list-donor-saved-definitions"},{"openapi":"get /admin/donors/assignees","title":"List eligible donor relationship managers","href":"/api-reference/donors/list-eligible-donor-relationship-managers"},{"openapi":"get /admin/donors/{hysform_id}/duplicates/field-types","title":"List fields and comparators available to the rule editor","href":"/api-reference/donors/list-fields-and-comparators-available-to-the-rule-editor"},{"openapi":"get /admin/files/saved_filters/{program_id}","title":"List file saved definitions","href":"/api-reference/donors/list-file-saved-definitions"},{"openapi":"get /admin/donors/duplicates/results","title":"List grouped duplicate-donor results","href":"/api-reference/donors/list-grouped-duplicate-donor-results"},{"openapi":"get /admin/household/fields","title":"List household custom form fields","href":"/api-reference/donors/list-household-custom-form-fields"},{"openapi":"get /admin/households/{household_id}/donations","title":"List household donations","href":"/api-reference/donors/list-household-donations"},{"openapi":"get /admin/households/{household_id}/donors","title":"List household member donors","href":"/api-reference/donors/list-household-member-donors"},{"openapi":"get /admin/duplicates/merge/batches","title":"List merge batches (paginated)","href":"/api-reference/donors/list-merge-batches-paginated"},{"openapi":"get /admin/entities/saved_filters/{program_id}","title":"List recipient/campaign saved definitions","href":"/api-reference/donors/list-recipientcampaign-saved-definitions"},{"openapi":"get /admin/sponsorships/saved_filters/{program_id}/{sponsorship}","title":"List sponsorship saved definitions","href":"/api-reference/donors/list-sponsorship-saved-definitions"},{"openapi":"post /admin/donors/merge","deprecated":true,"title":"Merge donors (single-shot, async)","href":"/api-reference/donors/merge-donors-single-shot-async"},{"openapi":"post /admin/donors/migrate-fields","title":"Migrate donor field data between custom JSON and standardized columns","href":"/api-reference/donors/migrate-donor-field-data-between-custom-json-and-standardized-columns"},{"openapi":"get /admin/duplicates/scans/{scan_run_id}/progress","title":"Poll a duplicate-scan run's status","href":"/api-reference/donors/poll-a-duplicate-scan-runs-status"},{"openapi":"get /admin/duplicates/merge/batches/{batch_id}/progress","title":"Poll a merge batch's status","href":"/api-reference/donors/poll-a-merge-batchs-status"},{"openapi":"get /admin/donors/exports/{uploadId}/status","title":"Poll a single donor-export job","href":"/api-reference/donors/poll-a-single-donor-export-job"},{"openapi":"post /admin/donors/field_options","title":"Post field options for donors","href":"/api-reference/donors/post-field-options-for-donors"},{"openapi":"post /admin/program/donors/tags/replacement-preview","title":"Preview existing donor tags before replacement","href":"/api-reference/donors/preview-existing-donor-tags-before-replacement"},{"openapi":"post /admin/donors/duplicates/preview-merge","title":"Preview field-level conflicts before merging donors","href":"/api-reference/donors/preview-field-level-conflicts-before-merging-donors"},{"openapi":"post /admin/sponsorships/lifecycle-preview","title":"Preview sponsorship archive or restoration","href":"/api-reference/donors/preview-sponsorship-archive-or-restoration"},{"openapi":"post /admin/donors/duplicates/manual-merge","title":"Queue a confirmed manual donor merge","href":"/api-reference/donors/queue-a-confirmed-manual-donor-merge"},{"openapi":"post /admin/donors/{hysform_id}/export","title":"Queue a CSV export of donors (async)","href":"/api-reference/donors/queue-a-csv-export-of-donors-async"},{"openapi":"post /admin/duplicates/merge/batch","title":"Queue a tracked, undoable batch of donor merges","href":"/api-reference/donors/queue-a-tracked-undoable-batch-of-donor-merges"},{"openapi":"post /admin/duplicates/merge/batches/{batch_id}/restore","title":"Re-apply a previously undone merge batch","href":"/api-reference/donors/re-apply-a-previously-undone-merge-batch"},{"openapi":"post /admin/donor-credit-card/{donor_id}/reconcile-bank-verification","title":"Reconcile a donor pending bank verification","href":"/api-reference/donors/reconcile-a-donor-pending-bank-verification"},{"openapi":"delete /admin/households/{household_id}/donors/{donor_id}","title":"Remove a donor from a household","href":"/api-reference/donors/remove-a-donor-from-a-household"},{"openapi":"delete /admin/donor/view/{report_id}/{hysform_id}","title":"Remove a saved donor view","href":"/api-reference/donors/remove-a-saved-donor-view"},{"openapi":"delete /admin/donors/{donor_id}/relationships","title":"Remove reciprocal donor contact links","href":"/api-reference/donors/remove-reciprocal-donor-contact-links"},{"openapi":"put /admin/donors/{hysform_id}/duplicates/rules","title":"Replace the duplicate-detection ruleset for a form","href":"/api-reference/donors/replace-the-duplicate-detection-ruleset-for-a-form"},{"openapi":"get /admin/donor/activate","title":"Restore a single archived donor","href":"/api-reference/donors/restore-a-single-archived-donor"},{"openapi":"post /admin/duplicates/merge/batches/{batch_id}/retry-refresh","title":"Retry post-merge donor refresh work","href":"/api-reference/donors/retry-post-merge-donor-refresh-work"},{"openapi":"post /admin/donors/duplicates/manual-review","title":"Review selected donor records for manual merge","href":"/api-reference/donors/review-selected-donor-records-for-manual-merge"},{"openapi":"post /admin/donationFilter/saved_filters","title":"Save a donation worksheet definition","href":"/api-reference/donors/save-a-donation-worksheet-definition"},{"openapi":"post /admin/donors/saved_filters","title":"Save a donor worksheet definition","href":"/api-reference/donors/save-a-donor-worksheet-definition"},{"openapi":"post /admin/files/saved_filters","title":"Save a file worksheet definition","href":"/api-reference/donors/save-a-file-worksheet-definition"},{"openapi":"post /admin/entities/saved_filters","title":"Save a recipient or campaign worksheet definition","href":"/api-reference/donors/save-a-recipient-or-campaign-worksheet-definition"},{"openapi":"post /admin/sponsorships/saved_filters","title":"Save a sponsorship worksheet definition","href":"/api-reference/donors/save-a-sponsorship-worksheet-definition"},{"openapi":"put /admin/donations/{hysform_id}/column-preferences","title":"Save personal donation worksheet columns","href":"/api-reference/donors/save-personal-donation-worksheet-columns"},{"openapi":"put /admin/donors/{hysform_id}/column-preferences","title":"Save personal donor worksheet columns","href":"/api-reference/donors/save-personal-donor-worksheet-columns"},{"openapi":"put /admin/sponsorships/{program_id}/column-preferences","title":"Save personal sponsorship worksheet columns","href":"/api-reference/donors/save-personal-sponsorship-worksheet-columns"},{"openapi":"get /admin/donors","title":"Search donors by name (typeahead)","href":"/api-reference/donors/search-donors-by-name-typeahead"},{"openapi":"post /admin/donor/view/{report_id}/{hysform_id}","title":"Select a saved donor report","href":"/api-reference/donors/select-a-saved-donor-report"},{"openapi":"post /admin/donor/view/{report_id}/{hysform_id}/{trashed}","title":"Select a saved donor report for the archived view","href":"/api-reference/donors/select-a-saved-donor-report-for-the-archived-view"},{"openapi":"post /admin/donors/notify","title":"Send notification to donors","href":"/api-reference/donors/send-notification-to-donors"},{"openapi":"post /admin/donor/{commitment_id}/email","title":"Send signup email to a donor","href":"/api-reference/donors/send-signup-email-to-a-donor"},{"openapi":"post /admin/donors/send_year_end","title":"Send year end statements to donors","href":"/api-reference/donors/send-year-end-statements-to-donors"},{"openapi":"patch /admin/donors/{donor_id}/relationships/primary","title":"Set a donor primary external contact","href":"/api-reference/donors/set-a-donor-primary-external-contact"},{"openapi":"post /admin/make_default_card/{donor_id}","title":"Set a donor's default Stripe card","href":"/api-reference/donors/set-a-donors-default-stripe-card"},{"openapi":"put /admin/donors/default-saved-view","title":"Set the default donor saved view","href":"/api-reference/donors/set-the-default-donor-saved-view"},{"openapi":"put /admin/saved-view-defaults/{module}","title":"Set the default worksheet saved view","href":"/api-reference/donors/set-the-default-worksheet-saved-view"},{"openapi":"put /admin/forms/{hysform_id}/primary","title":"Set the organization primary donor profile","href":"/api-reference/donors/set-the-organization-primary-donor-profile"},{"openapi":"patch /admin/donors/{donor_id}/relationships/remove_primary","title":"Stop using a related donor as primary contact","href":"/api-reference/donors/stop-using-a-related-donor-as-primary-contact"},{"openapi":"post /admin/donor-credit-card-details/{donor_id}/{action}","title":"Sync the donor's default Stripe source (or read it back)","href":"/api-reference/donors/sync-the-donors-default-stripe-source-or-read-it-back"},{"openapi":"delete /admin/duplicates/merge/batches/{batch_id}","title":"Undo a completed merge batch","href":"/api-reference/donors/undo-a-completed-merge-batch"},{"openapi":"patch /admin/households/{household_id}/donors/{donor_id}","title":"Update a household member relationship","href":"/api-reference/donors/update-a-household-member-relationship"},{"openapi":"post /admin/donor-credit-card/{donor_id}","title":"Update donor credit card details","href":"/api-reference/donors/update-donor-credit-card-details"},{"openapi":"patch /donor/{id}/field","title":"Update donor profile fields inline","href":"/api-reference/donors/update-donor-profile-fields-inline"},{"openapi":"patch /admin/households/{household_id}","title":"Update household and membership","href":"/api-reference/donors/update-household-and-membership"}]},{"group":"Email Calendar","pages":[{"openapi":"post /donors/{donor_id}/comments","title":"Add a plain-text donor comment","href":"/api-reference/email-calendar/add-a-plain-text-donor-comment"},{"openapi":"post /email-calendar/policies","title":"Add an email privacy rule","href":"/api-reference/email-calendar/add-an-email-privacy-rule"},{"openapi":"post /email-calendar/accounts/{account_id}/approve-import","title":"Approve my historical email import","href":"/api-reference/email-calendar/approve-my-historical-email-import"},{"openapi":"patch /interactions/email/{activity_id}/visibility","title":"Change legacy email body visibility","href":"/api-reference/email-calendar/change-legacy-email-body-visibility"},{"openapi":"post /donors/{donor_id}/interactions/calendar/events","title":"Create a calendar event for a donor","href":"/api-reference/email-calendar/create-a-calendar-event-for-a-donor"},{"openapi":"delete /donors/{donor_id}/comments/{comment_id}","title":"Delete a donor comment","href":"/api-reference/email-calendar/delete-a-donor-comment"},{"openapi":"delete /interactions/manual/{activity_id}","title":"Delete a manual interaction","href":"/api-reference/email-calendar/delete-a-manual-interaction"},{"openapi":"delete /email-calendar/accounts/{account_id}","title":"Disconnect my email/calendar account","href":"/api-reference/email-calendar/disconnect-my-emailcalendar-account"},{"openapi":"patch /donors/{donor_id}/comments/{comment_id}","title":"Edit my donor comment","href":"/api-reference/email-calendar/edit-my-donor-comment"},{"openapi":"patch /interactions/email/{activity_id}/link","title":"Link an email interaction to a donor","href":"/api-reference/email-calendar/link-an-email-interaction-to-a-donor"},{"openapi":"get /donors/{donor_id}/comments","title":"List a donor comments","href":"/api-reference/email-calendar/list-a-donor-comments"},{"openapi":"get /donors/{donor_id}/interactions/manual/acknowledgement-candidates","title":"List donor gifts eligible for acknowledgement","href":"/api-reference/email-calendar/list-donor-gifts-eligible-for-acknowledgement"},{"openapi":"get /email-calendar/policies","title":"List email privacy policy rules","href":"/api-reference/email-calendar/list-email-privacy-policy-rules"},{"openapi":"get /interactions/unmatched","title":"List legacy unmatched email interactions","href":"/api-reference/email-calendar/list-legacy-unmatched-email-interactions"},{"openapi":"get /email-calendar/accounts","title":"List my connected email/calendar accounts","href":"/api-reference/email-calendar/list-my-connected-emailcalendar-accounts"},{"openapi":"get /email-calendar/review","title":"List my private email review queue","href":"/api-reference/email-calendar/list-my-private-email-review-queue"},{"openapi":"get /interactions/manual/shared-visibility-options","title":"List permission groups for shared interactions","href":"/api-reference/email-calendar/list-permission-groups-for-shared-interactions"},{"openapi":"post /donors/{donor_id}/interactions/manual","title":"Log a donor manual interaction","href":"/api-reference/email-calendar/log-a-donor-manual-interaction"},{"openapi":"post /donors/{donor_id}/email-compose/preview","title":"Preview donor email merge text","href":"/api-reference/email-calendar/preview-donor-email-merge-text"},{"openapi":"post /email-calendar/settings/impact","title":"Preview email retention changes","href":"/api-reference/email-calendar/preview-email-retention-changes"},{"openapi":"post /email-calendar/accounts/{account_id}/preview","title":"Preview historical mailbox import","href":"/api-reference/email-calendar/preview-historical-mailbox-import"},{"openapi":"post /email-calendar/policies/preview","title":"Preview the effect of an email privacy rule","href":"/api-reference/email-calendar/preview-the-effect-of-an-email-privacy-rule"},{"openapi":"patch /email-calendar/review/{ingress_id}","title":"Promote or exclude an owned email candidate","href":"/api-reference/email-calendar/promote-or-exclude-an-owned-email-candidate"},{"openapi":"post /interactions/manual/imports/{import_id}/process","title":"Queue a validated manual-interaction import","href":"/api-reference/email-calendar/queue-a-validated-manual-interaction-import"},{"openapi":"get /donors/{donor_id}/interactions","title":"Read a donor unified interaction timeline","href":"/api-reference/email-calendar/read-a-donor-unified-interaction-timeline"},{"openapi":"get /interactions/manual/{activity_id}/body","title":"Read a manual interaction body","href":"/api-reference/email-calendar/read-a-manual-interaction-body"},{"openapi":"get /interactions/manual/{activity_id}/relationships","title":"Read accessible interaction relationships","href":"/api-reference/email-calendar/read-accessible-interaction-relationships"},{"openapi":"get /email-calendar/review/{ingress_id}","title":"Read an owned email review item","href":"/api-reference/email-calendar/read-an-owned-email-review-item"},{"openapi":"get /donors/{donor_id}/email-compose-context","title":"Read donor email compose options","href":"/api-reference/email-calendar/read-donor-email-compose-options"},{"openapi":"get /interactions/email/{activity_id}/body","title":"Read or fetch a private email body","href":"/api-reference/email-calendar/read-or-fetch-a-private-email-body"},{"openapi":"post /email-calendar/review/{ingress_id}/body","title":"Read or queue a retained private review body","href":"/api-reference/email-calendar/read-or-queue-a-retained-private-review-body"},{"openapi":"get /email-calendar/health","title":"Read workspace email ingestion health","href":"/api-reference/email-calendar/read-workspace-email-ingestion-health"},{"openapi":"get /email-calendar/settings","title":"Read workspace email/calendar settings","href":"/api-reference/email-calendar/read-workspace-emailcalendar-settings"},{"openapi":"post /email-calendar/accounts/{account_id}/reconnect","title":"Reconnect my email/calendar account","href":"/api-reference/email-calendar/reconnect-my-emailcalendar-account"},{"openapi":"delete /email-calendar/policies/{policy_id}","title":"Remove an email privacy policy rule","href":"/api-reference/email-calendar/remove-an-email-privacy-policy-rule"},{"openapi":"patch /interactions/email/{activity_id}/unlink","title":"Return an email donor relationship to review","href":"/api-reference/email-calendar/return-an-email-donor-relationship-to-review"},{"openapi":"put /email-calendar/settings","title":"Save workspace email/calendar settings","href":"/api-reference/email-calendar/save-workspace-emailcalendar-settings"},{"openapi":"post /donors/{donor_id}/email-compose/send","title":"Send donor email through my connected account","href":"/api-reference/email-calendar/send-donor-email-through-my-connected-account"},{"openapi":"post /donors/{donor_id}/interactions/email/send","title":"Send donor email through my connected account","href":"/api-reference/email-calendar/send-donor-email-through-my-connected-account-1"},{"openapi":"post /email-calendar/accounts/{provider}/connect","title":"Start a new email/calendar connection","href":"/api-reference/email-calendar/start-a-new-emailcalendar-connection"},{"openapi":"post /interactions/manual/summarize","title":"Suggest a summary for a manual interaction","href":"/api-reference/email-calendar/suggest-a-summary-for-a-manual-interaction"},{"openapi":"patch /email-calendar/events/{event_id}","title":"Update a Gratona-created calendar event","href":"/api-reference/email-calendar/update-a-gratona-created-calendar-event"},{"openapi":"patch /interactions/manual/{activity_id}","title":"Update a manual interaction","href":"/api-reference/email-calendar/update-a-manual-interaction"},{"openapi":"patch /email-calendar/accounts/{account_id}","title":"Update connected account settings or aliases","href":"/api-reference/email-calendar/update-connected-account-settings-or-aliases"},{"openapi":"post /interactions/manual/imports","title":"Upload a manual-interaction CSV","href":"/api-reference/email-calendar/upload-a-manual-interaction-csv"},{"openapi":"post /interactions/manual/imports/{import_id}/validate","title":"Validate a manual-interaction import mapping","href":"/api-reference/email-calendar/validate-a-manual-interaction-import-mapping"},{"openapi":"post /email-calendar/composio/complete-auth","title":"Verify a managed connection callback identity","href":"/api-reference/email-calendar/verify-a-managed-connection-callback-identity"}]},{"group":"Email Settings","pages":[{"openapi":"get /admin/email/settings","title":"Get email settings","href":"/api-reference/email-settings/get-email-settings"},{"openapi":"get /admin/export-email-settings","title":"Get export completion email preference","href":"/api-reference/email-settings/get-export-completion-email-preference"},{"openapi":"get /admin/mailgun_logs","title":"Get legacy delivery-log configuration","href":"/api-reference/email-settings/get-legacy-delivery-log-configuration"},{"openapi":"get /admin/email/settings/delivery-health","title":"Get sender email delivery health","href":"/api-reference/email-settings/get-sender-email-delivery-health"},{"openapi":"get /admin/mailgun_logs_data","title":"Get the first sender delivery log page","href":"/api-reference/email-settings/get-the-first-sender-delivery-log-page"},{"openapi":"post /admin/mailgun_logs_data","title":"Page through sender delivery logs","href":"/api-reference/email-settings/page-through-sender-delivery-logs"},{"openapi":"post /admin/email/settings","title":"Post email settings","href":"/api-reference/email-settings/post-email-settings"},{"openapi":"get /admin/mailgun_logs/{message_id}","title":"Read legacy Mailgun event results","href":"/api-reference/email-settings/read-legacy-mailgun-event-results"},{"openapi":"post /integrations/mailgun","title":"Save and verify email transport settings","href":"/api-reference/email-settings/save-and-verify-email-transport-settings"},{"openapi":"put /admin/export-email-settings","title":"Update export completion email preference","href":"/api-reference/email-settings/update-export-completion-email-preference"}]},{"group":"Entities","pages":[{"openapi":"get /admin/entity/{entity_id}/activate","title":"Activate Entity","href":"/api-reference/entities/activate-entity"},{"openapi":"post /admin/entities/{program_id}/activate","title":"Activate Multiple Entities","href":"/api-reference/entities/activate-multiple-entities"},{"openapi":"post /admin/entity/{program_id}","title":"Add New Entity","href":"/api-reference/entities/add-new-entity"},{"openapi":"delete /admin/entities/{program_id}","title":"Archive Entities","href":"/api-reference/entities/archive-entities"},{"openapi":"delete /admin/entity/{entity_id}","title":"Archive Entity","href":"/api-reference/entities/archive-entity"},{"openapi":"get /admin/entities/exports/{uploadId}","title":"Download a finished recipient export","href":"/api-reference/entities/download-a-finished-recipient-export"},{"openapi":"patch /admin/program/entity","title":"Edit a recipient","href":"/api-reference/entities/edit-a-recipient"},{"openapi":"get /admin/entities/{program_id}/headers/{trashed}","title":"Entity table headers","href":"/api-reference/entities/entity-table-headers"},{"openapi":"get /admin/entities/{program_id}/status-report","title":"Generate Entity Status Report","href":"/api-reference/entities/generate-entity-status-report"},{"openapi":"get /admin/fields/options/{program_id}/{type}","title":"Get Detailed Field Options","href":"/api-reference/entities/get-detailed-field-options"},{"openapi":"get /admin/entity/{program_id}","title":"Get program recipient form","href":"/api-reference/entities/get-program-recipient-form"},{"openapi":"get /admin/program/{program_id}/statistics","title":"Get Program Statistics","href":"/api-reference/entities/get-program-statistics"},{"openapi":"post /admin/show_all_entities","title":"List all entities for a program (legacy unpaginated)","href":"/api-reference/entities/list-all-entities-for-a-program-legacy-unpaginated"},{"openapi":"get /admin/entities/exports/active","title":"List recipient-export jobs currently queued or processing","href":"/api-reference/entities/list-recipient-export-jobs-currently-queued-or-processing"},{"openapi":"get /admin/get-entity/{program_id}","title":"Look up entities by their unique-field value within a program","href":"/api-reference/entities/look-up-entities-by-their-unique-field-value-within-a-program"},{"openapi":"post /admin/move/{entity_id}","title":"Move and entity to a different program","href":"/api-reference/entities/move-and-entity-to-a-different-program"},{"openapi":"put /admin/entities/move","title":"Move Multiple Entities","href":"/api-reference/entities/move-multiple-entities"},{"openapi":"delete /admin/entity/{entity_id}/delete","title":"Permanently delete an entity","href":"/api-reference/entities/permanently-delete-an-entity"},{"openapi":"delete /admin/entities/{program_id}/delete","title":"Permanently delete entities","href":"/api-reference/entities/permanently-delete-entities"},{"openapi":"get /admin/entities/exports/{uploadId}/status","title":"Poll a single recipient export","href":"/api-reference/entities/poll-a-single-recipient-export"},{"openapi":"patch /admin/program/entities","title":"Post Edit Multiple Entities","href":"/api-reference/entities/post-edit-multiple-entities"},{"openapi":"post /admin/fields/options/{program_id}/{type}","title":"Post Field Options","href":"/api-reference/entities/post-field-options"},{"openapi":"get /admin/entities/{program_id}/export","title":"Queue a CSV export of recipients (async)","href":"/api-reference/entities/queue-a-csv-export-of-recipients-async"},{"openapi":"delete /admin/view/{report_id}/{program_id}","title":"Remove a saved report","href":"/api-reference/entities/remove-a-saved-report"},{"openapi":"get /admin/programs/view/{report_id}/{program_id}","title":"Select a saved program report","href":"/api-reference/entities/select-a-saved-program-report"},{"openapi":"get /admin/programs/view/{report_id}/{program_id}/{trashed}","title":"Select a saved program report for the archived view","href":"/api-reference/entities/select-a-saved-program-report-for-the-archived-view"},{"openapi":"get /admin/entities/{program_id}","title":"Show All Entities for a specific program","href":"/api-reference/entities/show-all-entities-for-a-specific-program"},{"openapi":"get /admin/move/{entity_id}/compatible_programs","title":"View compatible programs when moving entities","href":"/api-reference/entities/view-compatible-programs-when-moving-entities"},{"openapi":"get /admin/program/entities/{id}","title":"View Entity Details","href":"/api-reference/entities/view-entity-details"}]},{"group":"Events","pages":[{"openapi":"post /admin/events/{eventId}/invitees","title":"Add a donor to an event invite list","href":"/api-reference/events/add-a-donor-to-an-event-invite-list"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/tables/{tableId}/host/{sessionId}/guests","title":"Add a hosted-table guest","href":"/api-reference/events/add-a-hosted-table-guest"},{"openapi":"post /admin/events/{eventId}/people","title":"Add an event person","href":"/api-reference/events/add-an-event-person"},{"openapi":"post /admin/events/{id}/archive","title":"Archive an event","href":"/api-reference/events/archive-an-event"},{"openapi":"post /admin/events/{eventId}/setup/{setup}/{id}/archive","title":"Archive event setup","href":"/api-reference/events/archive-event-setup"},{"openapi":"post /admin/events/{eventId}/sponsor-packages/{id}/archive","title":"Archive event setup","href":"/api-reference/events/archive-event-setup-1"},{"openapi":"put /admin/events/{eventId}/attendees/{attendeeId}/seat","title":"Assign or clear an event attendee seat","href":"/api-reference/events/assign-or-clear-an-event-attendee-seat"},{"openapi":"patch /admin/events/{eventId}/invitees/bulk-owner","title":"Assign owners to selected event invitees","href":"/api-reference/events/assign-owners-to-selected-event-invitees"},{"openapi":"post /admin/events/{eventId}/auction-bids/{bidId}/award","title":"Award an active event auction bid","href":"/api-reference/events/award-an-active-event-auction-bid"},{"openapi":"delete /frontend/public/events/{clientSlugOrId}/{eventSlug}/tables/{tableId}/host/{sessionId}/guests/{attendeeId}","title":"Cancel a hosted-table guest","href":"/api-reference/events/cancel-a-hosted-table-guest"},{"openapi":"delete /frontend/public/events/{clientSlugOrId}/{eventSlug}/waitlist/{token}","title":"Cancel a waitlist signup","href":"/api-reference/events/cancel-a-waitlist-signup"},{"openapi":"post /admin/events/{eventId}/auction-bids/{bidId}/cancel","title":"Cancel an event auction bid","href":"/api-reference/events/cancel-an-event-auction-bid"},{"openapi":"post /admin/events/{eventId}/orders/{orderId}/cancel","title":"Cancel or record a refund for event registration","href":"/api-reference/events/cancel-or-record-a-refund-for-event-registration"},{"openapi":"post /admin/events/{eventId}/orders/{orderId}/charge-saved-payment-method","title":"Charge an explicitly authorized saved event card","href":"/api-reference/events/charge-an-explicitly-authorized-saved-event-card"},{"openapi":"post /admin/events/{eventId}/check-ins/group","title":"Check in a complete event order","href":"/api-reference/events/check-in-a-complete-event-order"},{"openapi":"post /admin/events/{eventId}/check-ins/manual","title":"Check in an attendee manually","href":"/api-reference/events/check-in-an-attendee-manually"},{"openapi":"post /admin/events/{eventId}/check-ins/scan","title":"Check in an event QR ticket","href":"/api-reference/events/check-in-an-event-qr-ticket"},{"openapi":"post /admin/events/{eventId}/orders/{orderId}/complete-payment","title":"Complete a staff event payment","href":"/api-reference/events/complete-a-staff-event-payment"},{"openapi":"post /admin/events/{eventId}/orders","title":"Create a staff event registration","href":"/api-reference/events/create-a-staff-event-registration"},{"openapi":"post /admin/events","title":"Create an event","href":"/api-reference/events/create-an-event"},{"openapi":"post /admin/events/{eventId}/auction-items","title":"Create an event auction item","href":"/api-reference/events/create-an-event-auction-item"},{"openapi":"post /admin/events/{eventId}/communications","title":"Create an event communication","href":"/api-reference/events/create-an-event-communication"},{"openapi":"post /admin/events/{eventId}/preview-links","title":"Create an event preview link","href":"/api-reference/events/create-an-event-preview-link"},{"openapi":"post /admin/events/{eventId}/promo-codes","title":"Create an event promo code","href":"/api-reference/events/create-an-event-promo-code"},{"openapi":"post /admin/events/{eventId}/questions","title":"Create an event question","href":"/api-reference/events/create-an-event-question"},{"openapi":"post /admin/events/settings","title":"Create an event settings profile","href":"/api-reference/events/create-an-event-settings-profile"},{"openapi":"post /admin/events/{eventId}/sponsor-packages","title":"Create an event sponsor package","href":"/api-reference/events/create-an-event-sponsor-package"},{"openapi":"post /admin/events/{eventId}/tables","title":"Create an event table","href":"/api-reference/events/create-an-event-table"},{"openapi":"post /admin/events/{eventId}/ticket-types","title":"Create an event ticket type","href":"/api-reference/events/create-an-event-ticket-type"},{"openapi":"post /admin/events/{eventId}/invitation-links","title":"Create or rotate an event invitation link","href":"/api-reference/events/create-or-rotate-an-event-invitation-link"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders","title":"Create public event registration","href":"/api-reference/events/create-public-event-registration"},{"openapi":"post /admin/events/{eventId}/invitees/{inviteeId}/plans","title":"Create reviewed invitation staff tasks","href":"/api-reference/events/create-reviewed-invitation-staff-tasks"},{"openapi":"delete /admin/events/{id}","title":"Delete an event","href":"/api-reference/events/delete-an-event"},{"openapi":"delete /admin/events/{eventId}/auction-items/{id}","title":"Delete an unused event auction item","href":"/api-reference/events/delete-an-unused-event-auction-item"},{"openapi":"delete /admin/events/{eventId}/communications/{id}","title":"Delete an unused event communication","href":"/api-reference/events/delete-an-unused-event-communication"},{"openapi":"delete /admin/events/{eventId}/promo-codes/{id}","title":"Delete an unused event promo code","href":"/api-reference/events/delete-an-unused-event-promo-code"},{"openapi":"delete /admin/events/{eventId}/questions/{id}","title":"Delete an unused event question","href":"/api-reference/events/delete-an-unused-event-question"},{"openapi":"delete /admin/events/{eventId}/sponsor-packages/{id}","title":"Delete an unused event sponsor package","href":"/api-reference/events/delete-an-unused-event-sponsor-package"},{"openapi":"delete /admin/events/{eventId}/tables/{id}","title":"Delete an unused event table","href":"/api-reference/events/delete-an-unused-event-table"},{"openapi":"delete /admin/events/{eventId}/ticket-types/{id}","title":"Delete an unused event ticket type","href":"/api-reference/events/delete-an-unused-event-ticket-type"},{"openapi":"get /admin/events/exports/{uploadId}","title":"Download an event export","href":"/api-reference/events/download-an-event-export"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}/attendees/{attendeeId}/wallet-pass","title":"Download an event ticket wallet pass","href":"/api-reference/events/download-an-event-ticket-wallet-pass"},{"openapi":"post /admin/events/{id}/duplicate","title":"Duplicate event setup","href":"/api-reference/events/duplicate-event-setup"},{"openapi":"get /admin/events/{eventId}/reports/attendees.csv","title":"Export event attendees as CSV","href":"/api-reference/events/export-event-attendees-as-csv"},{"openapi":"get /admin/events/{eventId}/reports/orders.csv","title":"Export event orders as CSV","href":"/api-reference/events/export-event-orders-as-csv"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}/tables/{tableId}/host/{sessionId}","title":"Get a hosted event table","href":"/api-reference/events/get-a-hosted-event-table"},{"openapi":"get /frontend/public/events/{clientId}/{eventSlug}/document","title":"Get a public event HTML document","href":"/api-reference/events/get-a-public-event-html-document"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}","title":"Get a public event page","href":"/api-reference/events/get-a-public-event-page"},{"openapi":"get /admin/events/{eventId}/orders/{orderId}","title":"Get a staff event order","href":"/api-reference/events/get-a-staff-event-order"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}/waitlist/{token}","title":"Get a waitlist signup","href":"/api-reference/events/get-a-waitlist-signup"},{"openapi":"get /admin/events/exports/{uploadId}/status","title":"Get an event export status","href":"/api-reference/events/get-an-event-export-status"},{"openapi":"get /admin/events/{eventId}/reports/summary","title":"Get an event report summary","href":"/api-reference/events/get-an-event-report-summary"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}/attendees/{attendeeId}/qr.svg","title":"Get an event ticket QR image","href":"/api-reference/events/get-an-event-ticket-qr-image"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/waitlist/{token}/accept","title":"Get checkout data for a waitlist offer","href":"/api-reference/events/get-checkout-data-for-a-waitlist-offer"},{"openapi":"get /admin/events/{eventId}/check-ins/context","title":"Get event check-in context","href":"/api-reference/events/get-event-check-in-context"},{"openapi":"get /admin/events/{id}","title":"Get event details","href":"/api-reference/events/get-event-details"},{"openapi":"get /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}","title":"Get event registration management details","href":"/api-reference/events/get-event-registration-management-details"},{"openapi":"get /admin/events/{eventId}/registration-setup","title":"Get event registration setup","href":"/api-reference/events/get-event-registration-setup"},{"openapi":"get /admin/events/{eventId}/overview","title":"Get event setup overview","href":"/api-reference/events/get-event-setup-overview"},{"openapi":"get /admin/events/setup-options","title":"Get event setup selectors","href":"/api-reference/events/get-event-setup-selectors"},{"openapi":"get /admin/events/{eventId}/invitation-plan","title":"Get the event invitation plan","href":"/api-reference/events/get-the-event-invitation-plan"},{"openapi":"get /frontend/public/events/{clientId}/sitemap.xml","title":"Get the organization event sitemap","href":"/api-reference/events/get-the-organization-event-sitemap"},{"openapi":"get /admin/events/{id}/public-url","title":"Get the public event URL","href":"/api-reference/events/get-the-public-event-url"},{"openapi":"post /admin/events/{eventId}/check-ins/offline-import","title":"Import offline event check-ins","href":"/api-reference/events/import-offline-event-check-ins"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/waitlist","title":"Join an event waitlist","href":"/api-reference/events/join-an-event-waitlist"},{"openapi":"get /admin/events/{eventId}/waitlist","title":"List an event waitlist","href":"/api-reference/events/list-an-event-waitlist"},{"openapi":"get /frontend/events/{client_id}/{session_id}","title":"List donor event registrations","href":"/api-reference/events/list-donor-event-registrations"},{"openapi":"get /admin/events/{eventId}/attendees","title":"List event attendees","href":"/api-reference/events/list-event-attendees"},{"openapi":"get /admin/events/{eventId}/auction-bids","title":"List event auction bids","href":"/api-reference/events/list-event-auction-bids"},{"openapi":"get /admin/events/{eventId}/auction-items","title":"List event auction item records","href":"/api-reference/events/list-event-auction-item-records"},{"openapi":"get /admin/events/{eventId}/communications","title":"List event communications","href":"/api-reference/events/list-event-communications"},{"openapi":"get /admin/events/{eventId}/invitation-links","title":"List event invitation links","href":"/api-reference/events/list-event-invitation-links"},{"openapi":"get /admin/events/{eventId}/invitation-plans/presets","title":"List event invitation-plan presets","href":"/api-reference/events/list-event-invitation-plan-presets"},{"openapi":"get /admin/events/{eventId}/invitees","title":"List event invitees","href":"/api-reference/events/list-event-invitees"},{"openapi":"get /admin/events/{eventId}/interactions","title":"List event-linked interactions","href":"/api-reference/events/list-event-linked-interactions"},{"openapi":"get /admin/events/{eventId}/orders","title":"List event orders","href":"/api-reference/events/list-event-orders"},{"openapi":"get /admin/events/{eventId}/people","title":"List event people","href":"/api-reference/events/list-event-people"},{"openapi":"get /admin/events/{eventId}/preview-links","title":"List event preview links","href":"/api-reference/events/list-event-preview-links"},{"openapi":"get /admin/events/{eventId}/promo-codes","title":"List event promo code records","href":"/api-reference/events/list-event-promo-code-records"},{"openapi":"get /admin/events/{eventId}/questions","title":"List event question records","href":"/api-reference/events/list-event-question-records"},{"openapi":"get /admin/events/settings","title":"List event settings profiles","href":"/api-reference/events/list-event-settings-profiles"},{"openapi":"get /admin/events/{eventId}/setup/{setup}","title":"List event setup with lifecycle metadata","href":"/api-reference/events/list-event-setup-with-lifecycle-metadata"},{"openapi":"get /admin/events/{eventId}/sponsor-packages","title":"List event sponsor package records","href":"/api-reference/events/list-event-sponsor-package-records"},{"openapi":"get /admin/events/{eventId}/sponsors","title":"List event sponsors","href":"/api-reference/events/list-event-sponsors"},{"openapi":"get /admin/events/templates","title":"List event starter presets","href":"/api-reference/events/list-event-starter-presets"},{"openapi":"get /admin/events/{eventId}/tables","title":"List event table records","href":"/api-reference/events/list-event-table-records"},{"openapi":"get /admin/events/{eventId}/ticket-types","title":"List event ticket type records","href":"/api-reference/events/list-event-ticket-type-records"},{"openapi":"get /admin/events","title":"List events","href":"/api-reference/events/list-events"},{"openapi":"get /admin/events/{eventId}/donors/{donorId}/saved-payment-methods","title":"List masked donor payment methods for an event","href":"/api-reference/events/list-masked-donor-payment-methods-for-an-event"},{"openapi":"post /admin/events/{eventId}/check-ins/no-show","title":"Mark an event attendee as a no-show","href":"/api-reference/events/mark-an-event-attendee-as-a-no-show"},{"openapi":"post /admin/events/{eventId}/waitlist/{entryId}/offer","title":"Offer the next event waitlist place","href":"/api-reference/events/offer-the-next-event-waitlist-place"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/auction-bids","title":"Place a public event auction bid","href":"/api-reference/events/place-a-public-event-auction-bid"},{"openapi":"post /admin/events/{eventId}/invitees/selection/preview","title":"Preview adding selected donors to an event invite list","href":"/api-reference/events/preview-adding-selected-donors-to-an-event-invite-list"},{"openapi":"post /admin/events/{eventId}/communications/preview","title":"Preview an event communication","href":"/api-reference/events/preview-an-event-communication"},{"openapi":"get /admin/events/{eventId}/preview","title":"Preview an event page","href":"/api-reference/events/preview-an-event-page"},{"openapi":"post /admin/events/{eventId}/invitees/{inviteeId}/plan-preview","title":"Preview invitation tasks for an invitee","href":"/api-reference/events/preview-invitation-tasks-for-an-invitee"},{"openapi":"post /admin/events/{id}/publish","title":"Publish an event","href":"/api-reference/events/publish-an-event"},{"openapi":"post /admin/events/{eventId}/invitees/selection/apply","title":"Queue a reviewed event invite-list selection","href":"/api-reference/events/queue-a-reviewed-event-invite-list-selection"},{"openapi":"post /admin/events/{eventId}/invitees/selection/operations/{operationId}/retry","title":"Queue failed event invite-list records for retry","href":"/api-reference/events/queue-failed-event-invite-list-records-for-retry"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/quote","title":"Quote public event registration","href":"/api-reference/events/quote-public-event-registration"},{"openapi":"post /admin/events/{eventId}/check-ins/walk-in","title":"Register and check in an event walk-in","href":"/api-reference/events/register-and-check-in-an-event-walk-in"},{"openapi":"delete /admin/events/{eventId}/invitees/{inviteeId}","title":"Remove a donor from an event invite list","href":"/api-reference/events/remove-a-donor-from-an-event-invite-list"},{"openapi":"delete /admin/events/{eventId}/people/{personId}","title":"Remove an event person","href":"/api-reference/events/remove-an-event-person"},{"openapi":"put /admin/events/{eventId}/setup/{setup}/reorder","title":"Reorder event setup rows","href":"/api-reference/events/reorder-event-setup-rows"},{"openapi":"post /admin/events/{eventId}/invitees/{inviteeId}/plan-tasks/{stepKey}/repair","title":"Repair a missing invitation staff task","href":"/api-reference/events/repair-a-missing-invitation-staff-task"},{"openapi":"post /admin/events/{eventId}/invitation-task-date-review","title":"Reschedule reviewed event invitation tasks","href":"/api-reference/events/reschedule-reviewed-event-invitation-tasks"},{"openapi":"post /admin/events/{eventId}/invitation-plan/reset","title":"Reset an event invitation plan to the preset","href":"/api-reference/events/reset-an-event-invitation-plan-to-the-preset"},{"openapi":"post /frontend/public/event-previews/{clientId}/resolve","title":"Resolve an event preview link","href":"/api-reference/events/resolve-an-event-preview-link"},{"openapi":"post /admin/events/{eventId}/invitees/{inviteeId}/restore","title":"Restore an event invitee","href":"/api-reference/events/restore-an-event-invitee"},{"openapi":"post /admin/events/{eventId}/sponsor-packages/{id}/restore","title":"Restore event setup","href":"/api-reference/events/restore-event-setup"},{"openapi":"post /admin/events/{eventId}/setup/{setup}/{id}/restore","title":"Restore event setup","href":"/api-reference/events/restore-event-setup-1"},{"openapi":"get /admin/events/{eventId}/invitation-task-date-review","title":"Review event invitation task dates","href":"/api-reference/events/review-event-invitation-task-dates"},{"openapi":"delete /admin/events/{eventId}/invitation-links","title":"Revoke accessible event invitation links","href":"/api-reference/events/revoke-accessible-event-invitation-links"},{"openapi":"delete /admin/events/{eventId}/preview-links","title":"Revoke all event preview links","href":"/api-reference/events/revoke-all-event-preview-links"},{"openapi":"delete /admin/events/{eventId}/invitation-links/{linkId}","title":"Revoke an event invitation link","href":"/api-reference/events/revoke-an-event-invitation-link"},{"openapi":"delete /admin/events/{eventId}/preview-links/{linkId}","title":"Revoke an event preview link","href":"/api-reference/events/revoke-an-event-preview-link"},{"openapi":"put /admin/events/{eventId}/invitation-plan","title":"Save the event invitation plan","href":"/api-reference/events/save-the-event-invitation-plan"},{"openapi":"get /admin/events/{eventId}/check-ins/search","title":"Search event attendees for check-in","href":"/api-reference/events/search-event-attendees-for-check-in"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/auction-bids/{bidId}/checkout","title":"Start winning auction bid checkout","href":"/api-reference/events/start-winning-auction-bid-checkout"},{"openapi":"post /admin/events/{id}/unpublish","title":"Unpublish an event","href":"/api-reference/events/unpublish-an-event"},{"openapi":"put /frontend/public/events/{clientSlugOrId}/{eventSlug}/tables/{tableId}/host/{sessionId}/guests/{attendeeId}","title":"Update a hosted-table guest","href":"/api-reference/events/update-a-hosted-table-guest"},{"openapi":"put /admin/events/{eventId}/sponsors/{sponsorId}/deliverables/{deliverableId}","title":"Update a sponsor deliverable","href":"/api-reference/events/update-a-sponsor-deliverable"},{"openapi":"put /admin/events/{eventId}/auction-items/{id}","title":"Update an event auction item","href":"/api-reference/events/update-an-event-auction-item"},{"openapi":"put /admin/events/{eventId}/communications/{id}","title":"Update an event communication","href":"/api-reference/events/update-an-event-communication"},{"openapi":"patch /admin/events/{eventId}/invitees/{inviteeId}","title":"Update an event invitee","href":"/api-reference/events/update-an-event-invitee"},{"openapi":"put /admin/events/{eventId}/people/{personId}","title":"Update an event person","href":"/api-reference/events/update-an-event-person"},{"openapi":"put /admin/events/{eventId}/promo-codes/{id}","title":"Update an event promo code","href":"/api-reference/events/update-an-event-promo-code"},{"openapi":"put /admin/events/{eventId}/questions/{id}","title":"Update an event question","href":"/api-reference/events/update-an-event-question"},{"openapi":"put /admin/events/settings/{settingId}","title":"Update an event settings profile","href":"/api-reference/events/update-an-event-settings-profile"},{"openapi":"put /admin/events/{eventId}/sponsor-packages/{id}","title":"Update an event sponsor package","href":"/api-reference/events/update-an-event-sponsor-package"},{"openapi":"put /admin/events/{eventId}/tables/{id}","title":"Update an event table","href":"/api-reference/events/update-an-event-table"},{"openapi":"put /admin/events/{eventId}/ticket-types/{id}","title":"Update an event ticket type","href":"/api-reference/events/update-an-event-ticket-type"},{"openapi":"put /admin/events/{id}","title":"Update event details","href":"/api-reference/events/update-event-details"},{"openapi":"put /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}","title":"Update event registration guest details","href":"/api-reference/events/update-event-registration-guest-details"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}/storage/uploads","title":"Upload an event sponsor logo","href":"/api-reference/events/upload-an-event-sponsor-logo"},{"openapi":"post /frontend/public/events/{clientSlugOrId}/{eventSlug}/orders/{token}/complete-payment","title":"Verify public registration payment","href":"/api-reference/events/verify-public-registration-payment"}]},{"group":"Files","pages":[{"openapi":"post /admin/import_files/upload-sessions/{upload_session_id}/abort","title":"Abort an import upload session","href":"/api-reference/files/abort-an-import-upload-session"},{"openapi":"get /admin/box_response","title":"Complete Box OAuth for file uploads","href":"/api-reference/files/complete-box-oauth-for-file-uploads"},{"openapi":"post /admin/import_files/upload-sessions/{upload_session_id}/files/{file_id}/complete","title":"Confirm a staged import file upload","href":"/api-reference/files/confirm-a-staged-import-file-upload"},{"openapi":"post /admin/import_files/{program_id}/upload-sessions","title":"Create an import upload session","href":"/api-reference/files/create-an-import-upload-session"},{"openapi":"delete /file/{id}","title":"Delete a file","href":"/api-reference/files/delete-a-file"},{"openapi":"get /files/download-bundle/{token}","title":"Download a prepared file bundle","href":"/api-reference/files/download-a-prepared-file-bundle"},{"openapi":"put /file/{id}","title":"Edit a file","href":"/api-reference/files/edit-a-file"},{"openapi":"post /files/entities/batch","title":"Fetch files for multiple recipients","href":"/api-reference/files/fetch-files-for-multiple-recipients"},{"openapi":"post /files/filter/{program_id}","title":"Filter recipient files in a program","href":"/api-reference/files/filter-recipient-files-in-a-program"},{"openapi":"get /admin/import_files/upload-sessions/{upload_session_id}","title":"Get an import upload session","href":"/api-reference/files/get-an-import-upload-session"},{"openapi":"get /admin/bulk-edit-operations/{operationId}","title":"Get bulk operation progress","href":"/api-reference/files/get-bulk-operation-progress"},{"openapi":"get /admin/import/csv/{import_id}/progress","title":"Get CSV import progress","href":"/api-reference/files/get-csv-import-progress"},{"openapi":"get /admin/import_files/document-validation-progress/{validation_job_id}","title":"Get document upload validation progress","href":"/api-reference/files/get-document-upload-validation-progress"},{"openapi":"get /admin/import/donors-recipients/batch/{batch_id}/progress","title":"Get donor/recipient import batch progress (deprecated - use /import/batch/{batch_id}/progress)","href":"/api-reference/files/get-donorrecipient-import-batch-progress-deprecated--use-importbatch-progress"},{"openapi":"get /file/{id}","title":"Get file details","href":"/api-reference/files/get-file-details"},{"openapi":"get /files/{type}/{id}/table","title":"Get files table","href":"/api-reference/files/get-files-table"},{"openapi":"get /admin/import/batch/{batch_id}/progress","title":"Get import batch progress for any batch type, including attendance and enrollment","href":"/api-reference/files/get-import-batch-progress-for-any-batch-type-including-attendance-and-enrollment"},{"openapi":"get /admin/import/validation-progress/{validation_job_id}","title":"Get import validation progress for recipients and donors","href":"/api-reference/files/get-import-validation-progress-for-recipients-and-donors"},{"openapi":"get /admin/import/batches","title":"Get list of all import batches (payments, donors, recipients)","href":"/api-reference/files/get-list-of-all-import-batches-payments-donors-recipients"},{"openapi":"get /admin/import/donors-recipients/batches","title":"Get list of donor/recipient import batches (deprecated)","href":"/api-reference/files/get-list-of-donorrecipient-import-batches-deprecated"},{"openapi":"get /admin/import/payments/batches","title":"Get list of payment import batches (deprecated)","href":"/api-reference/files/get-list-of-payment-import-batches-deprecated"},{"openapi":"get /admin/import/payments/batch/{batch_id}/progress","title":"Get payment import batch progress","href":"/api-reference/files/get-payment-import-batch-progress"},{"openapi":"get /admin/import/payments/validation-progress/{validation_job_id}","title":"Get payment validation progress","href":"/api-reference/files/get-payment-validation-progress"},{"openapi":"get /admin/import_files/validation-progress/{validation_job_id}","title":"Get photo upload validation progress","href":"/api-reference/files/get-photo-upload-validation-progress"},{"openapi":"get /csv_import/{program_id}","title":"Import CSV for a specific program","href":"/api-reference/files/import-csv-for-a-specific-program"},{"openapi":"post /csv_import/{program_id}","title":"Import CSV for a specific program","href":"/api-reference/files/import-csv-for-a-specific-program-1"},{"openapi":"get /picture/{id}/placeholder","title":"Make placeholder picture","href":"/api-reference/files/make-placeholder-picture"},{"openapi":"get /picture/{id}/profile","title":"Make profile picture","href":"/api-reference/files/make-profile-picture"},{"openapi":"post /admin/recordUpload","title":"Post a record upload","href":"/api-reference/files/post-a-record-upload"},{"openapi":"get /admin/import/batch/{batch_id}/csv-preview","title":"Preview a saved import CSV","href":"/api-reference/files/preview-a-saved-import-csv"},{"openapi":"post /csv_process/{program_id}","title":"Process the import job for donors and recipients","href":"/api-reference/files/process-the-import-job-for-donors-and-recipients"},{"openapi":"post /csv_process/{program_id}/payments","title":"Process the import job for payments","href":"/api-reference/files/process-the-import-job-for-payments"},{"openapi":"post /admin/import_files/process-validated-documents/{validation_job_id}","title":"Process validated document uploads","href":"/api-reference/files/process-validated-document-uploads"},{"openapi":"post /admin/import_files/process-validated/{validation_job_id}","title":"Process validated photo uploads","href":"/api-reference/files/process-validated-photo-uploads"},{"openapi":"patch /files/permissions/bulk","title":"Queue a bulk file permission update","href":"/api-reference/files/queue-a-bulk-file-permission-update"},{"openapi":"post /files/profile/bulk","title":"Queue a bulk profile-file assignment","href":"/api-reference/files/queue-a-bulk-profile-file-assignment"},{"openapi":"post /files/delete-bundle","title":"Queue a recipient file deletion bundle","href":"/api-reference/files/queue-a-recipient-file-deletion-bundle"},{"openapi":"post /files/download-bundle","title":"Queue a recipient file download bundle","href":"/api-reference/files/queue-a-recipient-file-download-bundle"},{"openapi":"post /admin/import_files/{type}/{program_id}/import-documents","title":"Queue document imports from a CSV mapping","href":"/api-reference/files/queue-document-imports-from-a-csv-mapping"},{"openapi":"post /admin/import_files/{type}/{program_id}","title":"Queue photo files for import","href":"/api-reference/files/queue-photo-files-for-import"},{"openapi":"post /csv_process/{program_id}/relationships","title":"Queue the import job for commitment relationships","href":"/api-reference/files/queue-the-import-job-for-commitment-relationships"},{"openapi":"get /admin/create_thumbnails","title":"Queue thumbnails for existing uploads","href":"/api-reference/files/queue-thumbnails-for-existing-uploads"},{"openapi":"post /admin/import/payments/batch/{batch_id}/reconcile","title":"Reconcile a legacy payment import summary","href":"/api-reference/files/reconcile-a-legacy-payment-import-summary"},{"openapi":"post /admin/import/batch/{batch_type}/{batch_id}/restore","title":"Restore an undone import batch","href":"/api-reference/files/restore-an-undone-import-batch"},{"openapi":"post /admin/import/payments/batch/{batch_id}/resume","title":"Resume a stalled payment import","href":"/api-reference/files/resume-a-stalled-payment-import"},{"openapi":"post /admin/import/relationships/batch/{batch_id}/resume","title":"Resume saved commitment import finalization","href":"/api-reference/files/resume-saved-commitment-import-finalization"},{"openapi":"post /admin/import/payments/batch/{batch_id}/retry-recipient-refresh","title":"Retry payment import recipient reconciliation","href":"/api-reference/files/retry-payment-import-recipient-reconciliation"},{"openapi":"get /picture/{id}/rotate","title":"Rotate picture","href":"/api-reference/files/rotate-picture"},{"openapi":"get /files/search/{program_id}","title":"Search recipient files in a program","href":"/api-reference/files/search-recipient-files-in-a-program"},{"openapi":"post /admin/import/donors-recipients/batch","title":"Start a batch import for donors or recipients","href":"/api-reference/files/start-a-batch-import-for-donors-or-recipients"},{"openapi":"post /admin/import/relationships/batch","title":"Start a batch import for relationships","href":"/api-reference/files/start-a-batch-import-for-relationships"},{"openapi":"post /admin/import/payments/batch","title":"Start a batch payment import","href":"/api-reference/files/start-a-batch-payment-import"},{"openapi":"delete /admin/import/donors-recipients/batch/{batch_id}","title":"Undo a donor/recipient import batch (deprecated - use /import/batch/{batch_id})","href":"/api-reference/files/undo-a-donorrecipient-import-batch-deprecated--use-importbatch-"},{"openapi":"delete /admin/import/payments/batch/{batch_id}","title":"Undo a payment import batch","href":"/api-reference/files/undo-a-payment-import-batch"},{"openapi":"delete /admin/import/batch/{batch_type}/{batch_id}","title":"Undo an import batch for a specific batch type","href":"/api-reference/files/undo-an-import-batch-for-a-specific-batch-type"},{"openapi":"get /file/{type}/{id}/upload","title":"Upload a file","href":"/api-reference/files/upload-a-file"},{"openapi":"post /file/{type}/{id}/upload","title":"Upload a file","href":"/api-reference/files/upload-a-file-1"},{"openapi":"post /frontend/storage/uploads/{client_id}/{session_id}","title":"Upload a portal session file","href":"/api-reference/files/upload-a-portal-session-file"},{"openapi":"post /storage/uploads","title":"Upload an authenticated workspace file","href":"/api-reference/files/upload-an-authenticated-workspace-file"},{"openapi":"post /admin/import_files/{type}/{program_id}/validate-documents","title":"Validate document uploads before import","href":"/api-reference/files/validate-document-uploads-before-import"},{"openapi":"post /admin/import/donors/dry-run","title":"Validate donor data without persisting to database","href":"/api-reference/files/validate-donor-data-without-persisting-to-database"},{"openapi":"post /admin/import/payments/dry-run","title":"Validate payment data without persisting to database","href":"/api-reference/files/validate-payment-data-without-persisting-to-database"},{"openapi":"post /admin/import_files/{program_id}/validate","title":"Validate photo uploads before import","href":"/api-reference/files/validate-photo-uploads-before-import"},{"openapi":"post /admin/import/recipients/dry-run","title":"Validate recipient data without persisting to database","href":"/api-reference/files/validate-recipient-data-without-persisting-to-database"},{"openapi":"post /admin/import/relationships/dry-run","title":"Validate relationship data without persisting to database","href":"/api-reference/files/validate-relationship-data-without-persisting-to-database"}]},{"group":"Forms","pages":[{"openapi":"post /admin/form/field/{id}/{type}","title":"Add a form field","href":"/api-reference/forms/add-a-form-field"},{"openapi":"get /admin/edit_form_field/{id}/{type}","title":"Bootstrap data for the edit-form-field UI","href":"/api-reference/forms/bootstrap-data-for-the-edit-form-field-ui"},{"openapi":"post /admin/form/bulk_edit","title":"Bulk-create or bulk-update form fields","href":"/api-reference/forms/bulk-create-or-bulk-update-form-fields"},{"openapi":"post /admin/forms","title":"Create a new form","href":"/api-reference/forms/create-a-new-form"},{"openapi":"delete /admin/forms/{hysform_id}","title":"Delete a form","href":"/api-reference/forms/delete-a-form"},{"openapi":"delete /admin/form/field","title":"Delete a form field","href":"/api-reference/forms/delete-a-form-field"},{"openapi":"get /admin/program/{program_id}/donor-field-overrides","title":"Donor field permissions with per-program overrides","href":"/api-reference/forms/donor-field-permissions-with-per-program-overrides"},{"openapi":"put /admin/form/field","title":"Edit a form field","href":"/api-reference/forms/edit-a-form-field"},{"openapi":"get /admin/forms/{hysform_id}","title":"Form Details","href":"/api-reference/forms/form-details"},{"openapi":"get /admin/form/field/{id}/{type}","title":"Form field types","href":"/api-reference/forms/form-field-types"},{"openapi":"get /donors/{client_id}/forms","title":"Get all donor forms by client id","href":"/api-reference/forms/get-all-donor-forms-by-client-id"},{"openapi":"get /admin/forms","title":"Get all forms","href":"/api-reference/forms/get-all-forms"},{"openapi":"get /admin/forms/{hysform_id}/standardization/runs/{run_id}","title":"Get donor standardization run status","href":"/api-reference/forms/get-donor-standardization-run-status"},{"openapi":"get /admin/program/{program_id}/form-fields","title":"Get form fields for a program","href":"/api-reference/forms/get-form-fields-for-a-program"},{"openapi":"get /admin/forms/{hysform_id}/standard-field-settings","title":"Get the standardized donor field settings for a donor form","href":"/api-reference/forms/get-the-standardized-donor-field-settings-for-a-donor-form"},{"openapi":"get /admin/forms/{hysform_id}/manage","title":"Manage a form","href":"/api-reference/forms/manage-a-form"},{"openapi":"get /admin/form/fields/order/{type}","title":"Persist a reordered form-field list","href":"/api-reference/forms/persist-a-reordered-form-field-list"},{"openapi":"post /admin/forms/{hysform_id}/standardization/audit","title":"Queue a donor standardization audit","href":"/api-reference/forms/queue-a-donor-standardization-audit"},{"openapi":"delete /admin/program/{program_id}/donor-field-overrides","title":"Reset program donor-field visibility overrides","href":"/api-reference/forms/reset-program-donor-field-visibility-overrides"},{"openapi":"get /admin/forms/{hysform_id}/standardization/audit","title":"Standardization step 1 — audit current state","href":"/api-reference/forms/standardization-step-1-—-audit-current-state"},{"openapi":"post /admin/forms/{hysform_id}/standardization/preview","title":"Standardization step 2 — preview the migration with a candidate mapping","href":"/api-reference/forms/standardization-step-2-—-preview-the-migration-with-a-candidate-mapping"},{"openapi":"post /admin/forms/{hysform_id}/standardization/migrate","title":"Standardization step 3 — queue the data migration","href":"/api-reference/forms/standardization-step-3-—-queue-the-data-migration"},{"openapi":"post /admin/forms/{hysform_id}/standardization/verify","title":"Standardization step 4 — verify the migrated data","href":"/api-reference/forms/standardization-step-4-—-verify-the-migrated-data"},{"openapi":"post /admin/forms/{hysform_id}/standardization/finalize","title":"Standardization step 5 — finalize and lock the form","href":"/api-reference/forms/standardization-step-5-—-finalize-and-lock-the-form"},{"openapi":"post /admin/forms/{hysform_id}/standardization/rollback","title":"Standardization step 6 — roll back the rollout","href":"/api-reference/forms/standardization-step-6-—-roll-back-the-rollout"},{"openapi":"put /admin/forms/{hysform_id}","title":"Update a form","href":"/api-reference/forms/update-a-form"},{"openapi":"put /admin/program/{program_id}/donor-field-overrides","title":"Upsert a per-program donor-field permission override","href":"/api-reference/forms/upsert-a-per-program-donor-field-permission-override"},{"openapi":"put /admin/forms/{hysform_id}/standard-field-settings","title":"Upsert one standardized donor field setting","href":"/api-reference/forms/upsert-one-standardized-donor-field-setting"}]},{"group":"Frontend","pages":[{"openapi":"post /frontend/checkout/designation/{client_id}/{program_id}/{currency}/{session_id}","title":"Add a designation to the checkout","href":"/api-reference/frontend/add-a-designation-to-the-checkout"},{"openapi":"get /frontend/order/{client_id}/{program_id}/{session_id}","title":"Checkout","href":"/api-reference/frontend/checkout"},{"openapi":"post /frontend/checkout/signup/{client_id}/{program_id}/{session_id}","title":"Create a new donor and process their donation","href":"/api-reference/frontend/create-a-new-donor-and-process-their-donation"},{"openapi":"get /frontend/order/sponsorships/{client_id}/{program_id}/{session_id}","title":"Handle the checkout process for sponsorships","href":"/api-reference/frontend/handle-the-checkout-process-for-sponsorships"},{"openapi":"post /frontend/checkout/login/{client_id}/{program_id}/{session_id}","title":"Login a donor and process their donation","href":"/api-reference/frontend/login-a-donor-and-process-their-donation"},{"openapi":"put /frontend/checkout/designation/frequency/{client_id}/{program_id}/{designation_id}/{frequency}/{session_id}","title":"Update the frequency for a specific designation in the checkout","href":"/api-reference/frontend/update-the-frequency-for-a-specific-designation-in-the-checkout"},{"openapi":"get /frontend/entities/random/{client_id}/{program_id}","title":"View a random entity","href":"/api-reference/frontend/view-a-random-entity"},{"openapi":"get /frontend/entity/{client_id}/{program_id}/{entity_id}/{session_id}","title":"View entity details","href":"/api-reference/frontend/view-entity-details"}]},{"group":"Fundraising","pages":[{"openapi":"post /admin/donation/{donation_id}/acknowledge","title":"Acknowledge a fundraising gift","href":"/api-reference/fundraising/acknowledge-a-fundraising-gift"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves","title":"Add a stewardship-plan move","href":"/api-reference/fundraising/add-a-stewardship-plan-move"},{"openapi":"post /admin/fundraising/relationship-provisioning/apply","title":"Apply selected relationship-provisioning candidates","href":"/api-reference/fundraising/apply-selected-relationship-provisioning-candidates"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/approve","title":"Approve a handwritten-card order","href":"/api-reference/fundraising/approve-a-handwritten-card-order"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/archive","title":"Archive a stewardship plan","href":"/api-reference/fundraising/archive-a-stewardship-plan"},{"openapi":"put /admin/fundraising/caseload/{donor_id}/assignment","title":"Assign a donor or household relationship manager","href":"/api-reference/fundraising/assign-a-donor-or-household-relationship-manager"},{"openapi":"put /admin/fundraising/portfolio/{donor_id}/assignment","title":"Assign a donor or household relationship manager","href":"/api-reference/fundraising/assign-a-donor-or-household-relationship-manager-1"},{"openapi":"post /admin/giving-anniversaries/opportunities/{id}/assign","title":"Assign a giving-anniversary owner","href":"/api-reference/fundraising/assign-a-giving-anniversary-owner"},{"openapi":"put /admin/fundraising/relationship-groups/{relationship_group_id}/assignment","title":"Assign a stewardship-relationship manager","href":"/api-reference/fundraising/assign-a-stewardship-relationship-manager"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/cancel","title":"Cancel a stewardship-plan move","href":"/api-reference/fundraising/cancel-a-stewardship-plan-move"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/cancel","title":"Cancel a submitted handwritten-card order","href":"/api-reference/fundraising/cancel-a-submitted-handwritten-card-order"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/complete","title":"Complete a stewardship-plan move","href":"/api-reference/fundraising/complete-a-stewardship-plan-move"},{"openapi":"post /admin/handwrytten/drafts","title":"Create a handwritten-card draft and quote","href":"/api-reference/fundraising/create-a-handwritten-card-draft-and-quote"},{"openapi":"post /admin/handwrytten/rules","title":"Create a handwritten-card stewardship rule","href":"/api-reference/fundraising/create-a-handwritten-card-stewardship-rule"},{"openapi":"post /admin/fundraising/stewardship-plans","title":"Create a stewardship plan","href":"/api-reference/fundraising/create-a-stewardship-plan"},{"openapi":"post /admin/fundraising/relationship-groups","title":"Create a stewardship relationship","href":"/api-reference/fundraising/create-a-stewardship-relationship"},{"openapi":"delete /admin/fundraising/relationship-groups/{relationship_group_id}","title":"Deactivate a stewardship relationship","href":"/api-reference/fundraising/deactivate-a-stewardship-relationship"},{"openapi":"post /admin/giving-anniversaries/opportunities/{id}/dismiss","title":"Dismiss a giving-anniversary opportunity","href":"/api-reference/fundraising/dismiss-a-giving-anniversary-opportunity"},{"openapi":"get /admin/handwrytten/orders/{handwryttenOrderId}/proof/font","title":"Download a handwriting-preview font","href":"/api-reference/fundraising/download-a-handwriting-preview-font"},{"openapi":"get /admin/fundraising/cohorts/{bucket}/export","title":"Export a fundraising cohort bucket","href":"/api-reference/fundraising/export-a-fundraising-cohort-bucket"},{"openapi":"get /admin/fundraising/portfolio/md-pep/export","title":"Export a personal engagement worksheet","href":"/api-reference/fundraising/export-a-personal-engagement-worksheet"},{"openapi":"get /admin/fundraising/interactions/export","title":"Export fundraising relationship contacts","href":"/api-reference/fundraising/export-fundraising-relationship-contacts"},{"openapi":"get /admin/fundraising/work-items/export","title":"Export fundraising stewardship Work","href":"/api-reference/fundraising/export-fundraising-stewardship-work"},{"openapi":"get /admin/fundraising/transactions/export","title":"Export fundraising transactions","href":"/api-reference/fundraising/export-fundraising-transactions"},{"openapi":"get /admin/giving-anniversaries/opportunities/export","title":"Export giving-anniversary opportunities","href":"/api-reference/fundraising/export-giving-anniversary-opportunities"},{"openapi":"post /admin/fundraising/install-default-views","title":"Install fundraising default saved views","href":"/api-reference/fundraising/install-fundraising-default-saved-views"},{"openapi":"put /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/task","title":"Link a Task to a stewardship move","href":"/api-reference/fundraising/link-a-task-to-a-stewardship-move"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/evidence","title":"Link interaction evidence to a stewardship move","href":"/api-reference/fundraising/link-interaction-evidence-to-a-stewardship-move"},{"openapi":"get /admin/handwrytten/catalog","title":"List available handwritten-card catalog items","href":"/api-reference/fundraising/list-available-handwritten-card-catalog-items"},{"openapi":"get /admin/fundraising/fundraisers","title":"List eligible relationship managers","href":"/api-reference/fundraising/list-eligible-relationship-managers"},{"openapi":"get /admin/fundraising/relationship-managers","title":"List eligible relationship managers","href":"/api-reference/fundraising/list-eligible-relationship-managers-1"},{"openapi":"get /admin/fundraising/unacknowledged-gifts","title":"List eligible unacknowledged gifts","href":"/api-reference/fundraising/list-eligible-unacknowledged-gifts"},{"openapi":"get /admin/fundraising/caseload","title":"List fundraising caseload","href":"/api-reference/fundraising/list-fundraising-caseload"},{"openapi":"get /admin/fundraising/portfolio","title":"List fundraising portfolio relationships","href":"/api-reference/fundraising/list-fundraising-portfolio-relationships"},{"openapi":"get /admin/fundraising/interactions","title":"List fundraising relationship contacts","href":"/api-reference/fundraising/list-fundraising-relationship-contacts"},{"openapi":"get /admin/fundraising/work-items","title":"List fundraising stewardship Work","href":"/api-reference/fundraising/list-fundraising-stewardship-work"},{"openapi":"get /admin/fundraising/transactions","title":"List fundraising transactions","href":"/api-reference/fundraising/list-fundraising-transactions"},{"openapi":"get /admin/giving-anniversaries/opportunities","title":"List giving-anniversary opportunities","href":"/api-reference/fundraising/list-giving-anniversary-opportunities"},{"openapi":"get /admin/handwrytten/queue","title":"List handwritten-card orders","href":"/api-reference/fundraising/list-handwritten-card-orders"},{"openapi":"get /admin/handwrytten/rules","title":"List handwritten-card stewardship rules","href":"/api-reference/fundraising/list-handwritten-card-stewardship-rules"},{"openapi":"get /admin/fundraising/cohorts/{bucket}","title":"List one fundraising cohort bucket","href":"/api-reference/fundraising/list-one-fundraising-cohort-bucket"},{"openapi":"get /admin/fundraising/stewardship-plans/{plan_id}/reviews","title":"List stewardship-plan reviews","href":"/api-reference/fundraising/list-stewardship-plan-reviews"},{"openapi":"get /admin/fundraising/relationship-groups","title":"List stewardship relationships","href":"/api-reference/fundraising/list-stewardship-relationships"},{"openapi":"post /admin/giving-anniversaries/opportunities/{id}/mark-acted","title":"Mark a giving anniversary acted","href":"/api-reference/fundraising/mark-a-giving-anniversary-acted"},{"openapi":"post /admin/fundraising/cohorts/{bucket}/reactivation","title":"Prepare a lost-donor reactivation action","href":"/api-reference/fundraising/prepare-a-lost-donor-reactivation-action"},{"openapi":"get /admin/fundraising/digest/preview","title":"Preview a fundraising stewardship digest","href":"/api-reference/fundraising/preview-a-fundraising-stewardship-digest"},{"openapi":"post /admin/fundraising/stewardship-plans/lifecycle-impact","title":"Preview relationship changes affecting stewardship plans","href":"/api-reference/fundraising/preview-relationship-changes-affecting-stewardship-plans"},{"openapi":"get /admin/fundraising/relationship-provisioning/preview","title":"Preview stewardship relationship provisioning","href":"/api-reference/fundraising/preview-stewardship-relationship-provisioning"},{"openapi":"post /admin/handwrytten/credits/purchase","title":"Purchase or resume a Postal Mail balance pack","href":"/api-reference/fundraising/purchase-or-resume-a-postal-mail-balance-pack"},{"openapi":"post /admin/donations/acknowledge","title":"Queue bulk fundraising gift acknowledgement","href":"/api-reference/fundraising/queue-bulk-fundraising-gift-acknowledgement"},{"openapi":"get /admin/fundraising/transactions/donor/{donor_id}/evidence","title":"Read a donor comparison-period gift evidence","href":"/api-reference/fundraising/read-a-donor-comparison-period-gift-evidence"},{"openapi":"get /admin/donors/{donor_id}/giving-anniversaries","title":"Read a donor giving-anniversary summary","href":"/api-reference/fundraising/read-a-donor-giving-anniversary-summary"},{"openapi":"get /admin/fundraising/relationship-groups/for-donor/{donor_id}","title":"Read a donor stewardship-relationship memberships","href":"/api-reference/fundraising/read-a-donor-stewardship-relationship-memberships"},{"openapi":"get /admin/fundraising/caseload/{donor_id}","title":"Read a fundraising donor profile","href":"/api-reference/fundraising/read-a-fundraising-donor-profile"},{"openapi":"get /admin/fundraising/portfolio/{donor_id}","title":"Read a fundraising donor profile","href":"/api-reference/fundraising/read-a-fundraising-donor-profile-1"},{"openapi":"get /admin/fundraising/portfolio/household/{household_id}","title":"Read a fundraising household profile","href":"/api-reference/fundraising/read-a-fundraising-household-profile"},{"openapi":"get /admin/fundraising/relationship-groups/{relationship_group_id}/profile","title":"Read a fundraising relationship profile","href":"/api-reference/fundraising/read-a-fundraising-relationship-profile"},{"openapi":"get /admin/giving-anniversaries/opportunities/{id}","title":"Read a giving-anniversary opportunity","href":"/api-reference/fundraising/read-a-giving-anniversary-opportunity"},{"openapi":"get /admin/handwrytten/orders/{handwryttenOrderId}/proof","title":"Read a handwritten-card proof","href":"/api-reference/fundraising/read-a-handwritten-card-proof"},{"openapi":"get /admin/fundraising/portfolio/md-pep","title":"Read a personal engagement worksheet","href":"/api-reference/fundraising/read-a-personal-engagement-worksheet"},{"openapi":"get /admin/fundraising/stewardship-plans/{plan_id}","title":"Read a stewardship-plan workspace","href":"/api-reference/fundraising/read-a-stewardship-plan-workspace"},{"openapi":"get /admin/fundraising/relationship-groups/{relationship_group_id}","title":"Read a stewardship relationship","href":"/api-reference/fundraising/read-a-stewardship-relationship"},{"openapi":"get /admin/fundraising/cohorts","title":"Read fundraising donor cohorts","href":"/api-reference/fundraising/read-fundraising-donor-cohorts"},{"openapi":"get /admin/fundraising/filter-options","title":"Read fundraising filter options","href":"/api-reference/fundraising/read-fundraising-filter-options"},{"openapi":"get /admin/fundraising/settings","title":"Read fundraising hub settings","href":"/api-reference/fundraising/read-fundraising-hub-settings"},{"openapi":"get /admin/fundraising/overview","title":"Read fundraising overview metrics","href":"/api-reference/fundraising/read-fundraising-overview-metrics"},{"openapi":"get /admin/fundraising/reporting-fields","title":"Read fundraising reporting field definitions","href":"/api-reference/fundraising/read-fundraising-reporting-field-definitions"},{"openapi":"get /admin/giving-anniversaries/settings","title":"Read giving-anniversary settings","href":"/api-reference/fundraising/read-giving-anniversary-settings"},{"openapi":"get /admin/handwrytten/attribution","title":"Read handwritten-card outcome attribution","href":"/api-reference/fundraising/read-handwritten-card-outcome-attribution"},{"openapi":"get /admin/handwrytten/governance","title":"Read handwritten-card spending governance","href":"/api-reference/fundraising/read-handwritten-card-spending-governance"},{"openapi":"get /admin/handwrytten/settings","title":"Read handwritten-card workspace settings","href":"/api-reference/fundraising/read-handwritten-card-workspace-settings"},{"openapi":"get /admin/fundraising/stewardship-plans/subjects/{subject_type}/{subject_id}","title":"Read plans for a relationship subject","href":"/api-reference/fundraising/read-plans-for-a-relationship-subject"},{"openapi":"get /admin/handwrytten/credits","title":"Read Postal Mail balance","href":"/api-reference/fundraising/read-postal-mail-balance"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/reviews","title":"Record a stewardship-plan review","href":"/api-reference/fundraising/record-a-stewardship-plan-review"},{"openapi":"post /admin/handwrytten/work-items/{workItemId}/complete","title":"Record a stewardship Work completion","href":"/api-reference/fundraising/record-a-stewardship-work-completion"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/sync-status","title":"Refresh handwritten-card delivery status","href":"/api-reference/fundraising/refresh-handwritten-card-delivery-status"},{"openapi":"post /admin/handwrytten/catalog/sync","title":"Refresh the handwritten-card catalog","href":"/api-reference/fundraising/refresh-the-handwritten-card-catalog"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/reject","title":"Reject a handwritten-card order","href":"/api-reference/fundraising/reject-a-handwritten-card-order"},{"openapi":"post /admin/donation/{donation_id}/unacknowledge","title":"Remove a fundraising gift acknowledgement","href":"/api-reference/fundraising/remove-a-fundraising-gift-acknowledgement"},{"openapi":"post /admin/giving-anniversaries/opportunities/{id}/reopen","title":"Reopen a giving-anniversary opportunity","href":"/api-reference/fundraising/reopen-a-giving-anniversary-opportunity"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/reopen","title":"Reopen a stewardship-plan move","href":"/api-reference/fundraising/reopen-a-stewardship-plan-move"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/reorder","title":"Reorder a qualification move","href":"/api-reference/fundraising/reorder-a-qualification-move"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/work/reopen","title":"Restore stewardship-move Work","href":"/api-reference/fundraising/restore-stewardship-move-work"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/retry","title":"Retry a failed handwritten-card submission","href":"/api-reference/fundraising/retry-a-failed-handwritten-card-submission"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/roll-forward","title":"Roll a managed plan into its next period","href":"/api-reference/fundraising/roll-a-managed-plan-into-its-next-period"},{"openapi":"get /admin/fundraising/relationship-groups/donor-options","title":"Search donor options for stewardship relationships","href":"/api-reference/fundraising/search-donor-options-for-stewardship-relationships"},{"openapi":"get /admin/handwrytten/recipients","title":"Search handwritten-card recipients","href":"/api-reference/fundraising/search-handwritten-card-recipients"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/skip","title":"Skip a stewardship-plan move","href":"/api-reference/fundraising/skip-a-stewardship-plan-move"},{"openapi":"post /admin/giving-anniversaries/opportunities/{id}/snooze","title":"Snooze a giving-anniversary opportunity","href":"/api-reference/fundraising/snooze-a-giving-anniversary-opportunity"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/work/snooze","title":"Snooze stewardship-move Work","href":"/api-reference/fundraising/snooze-stewardship-move-work"},{"openapi":"post /admin/handwrytten/orders/{handwryttenOrderId}/submit","title":"Submit an approved handwritten card","href":"/api-reference/fundraising/submit-an-approved-handwritten-card"},{"openapi":"post /admin/fundraising/stewardship-plans/{plan_id}/transition","title":"Transition a stewardship plan","href":"/api-reference/fundraising/transition-a-stewardship-plan"},{"openapi":"delete /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/task","title":"Unlink a Task from a stewardship move","href":"/api-reference/fundraising/unlink-a-task-from-a-stewardship-move"},{"openapi":"delete /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}/evidence/{evidence_id}","title":"Unlink interaction evidence from a stewardship move","href":"/api-reference/fundraising/unlink-interaction-evidence-from-a-stewardship-move"},{"openapi":"put /admin/fundraising/stewardship-plans/{plan_id}/moves/{move_id}","title":"Update a stewardship-plan move","href":"/api-reference/fundraising/update-a-stewardship-plan-move"},{"openapi":"put /admin/fundraising/relationship-groups/{relationship_group_id}","title":"Update a stewardship relationship","href":"/api-reference/fundraising/update-a-stewardship-relationship"},{"openapi":"put /admin/fundraising/settings","title":"Update fundraising hub settings","href":"/api-reference/fundraising/update-fundraising-hub-settings"},{"openapi":"put /admin/giving-anniversaries/settings","title":"Update giving-anniversary settings","href":"/api-reference/fundraising/update-giving-anniversary-settings"},{"openapi":"put /admin/handwrytten/governance","title":"Update handwritten-card spending governance","href":"/api-reference/fundraising/update-handwritten-card-spending-governance"},{"openapi":"put /admin/handwrytten/preferences","title":"Update handwritten-card workspace defaults","href":"/api-reference/fundraising/update-handwritten-card-workspace-defaults"},{"openapi":"put /admin/fundraising/stewardship-plans/{plan_id}","title":"Update stewardship-plan strategy","href":"/api-reference/fundraising/update-stewardship-plan-strategy"},{"openapi":"post /admin/handwrytten/validate-account","title":"Validate the handwritten-card connection","href":"/api-reference/fundraising/validate-the-handwritten-card-connection"}]},{"group":"Historical Archived Updates","pages":[{"openapi":"get /admin/list_archived_forms/{type}/{id}/{archived_hysform_id}","title":"List historical archived updates for one donor or recipient","href":"/api-reference/historical-archived-updates/list-historical-archived-updates-for-one-donor-or-recipient"},{"openapi":"get /admin/view_archived_form/{archived_form_id}","title":"Read one historical archived update","href":"/api-reference/historical-archived-updates/read-one-historical-archived-update"},{"openapi":"get /admin/submit_form/{type}/{id}/{program_id}/{form_id}","deprecated":true,"title":"Retired archived-update authoring bootstrap","href":"/api-reference/historical-archived-updates/retired-archived-update-authoring-bootstrap"},{"openapi":"get /admin/edit_archived_form/{archived_form_id}","deprecated":true,"title":"Retired archived-update edit bootstrap","href":"/api-reference/historical-archived-updates/retired-archived-update-edit-bootstrap"},{"openapi":"post /admin/program/form","deprecated":true,"title":"Retired archived-update form attachment","href":"/api-reference/historical-archived-updates/retired-archived-update-form-attachment"},{"openapi":"get /admin/remove_submit_form/{type}/{program_id}/{form_id}","deprecated":true,"title":"Retired archived-update form detachment","href":"/api-reference/historical-archived-updates/retired-archived-update-form-detachment"},{"openapi":"post /admin/edit_archived_form/{archived_form_id}","deprecated":true,"title":"Retired archived-update mutation","href":"/api-reference/historical-archived-updates/retired-archived-update-mutation"},{"openapi":"get /admin/submit_form_notification/{program_id}/{form_id}","deprecated":true,"title":"Retired archived-update notification configuration","href":"/api-reference/historical-archived-updates/retired-archived-update-notification-configuration"},{"openapi":"post /admin/submit_form_notification/{program_id}/{form_id}","deprecated":true,"title":"Retired archived-update notification mutation","href":"/api-reference/historical-archived-updates/retired-archived-update-notification-mutation"},{"openapi":"post /admin/submit_form/{type}/{id}/{program_id}/{form_id}","deprecated":true,"title":"Retired archived-update submission","href":"/api-reference/historical-archived-updates/retired-archived-update-submission"},{"openapi":"post /admin/progress_report/email","deprecated":true,"title":"Retired global Progress Reports email export","href":"/api-reference/historical-archived-updates/retired-global-progress-reports-email-export"},{"openapi":"post /admin/progress_report","deprecated":true,"title":"Retired global Progress Reports list","href":"/api-reference/historical-archived-updates/retired-global-progress-reports-list"},{"openapi":"get /admin/progress_report","deprecated":true,"title":"Retired global Progress Reports module","href":"/api-reference/historical-archived-updates/retired-global-progress-reports-module"}]},{"group":"Impact Stories","pages":[{"openapi":"post /admin/impact-stories/{storyId}/approve","title":"Approve a story for reuse","href":"/api-reference/impact-stories/approve-a-story-for-reuse"},{"openapi":"post /admin/impact-stories/{storyId}/offers/{offerId}/approve","title":"Approve a story offer","href":"/api-reference/impact-stories/approve-a-story-offer"},{"openapi":"post /admin/impact-stories/{storyId}/archive","title":"Archive an Impact Story","href":"/api-reference/impact-stories/archive-an-impact-story"},{"openapi":"post /admin/impact-stories/{storyId}/assets","title":"Attach a source or upload to a story","href":"/api-reference/impact-stories/attach-a-source-or-upload-to-a-story"},{"openapi":"post /admin/impact-stories/{storyId}/library-assets","title":"Attach authorized Library files to a story","href":"/api-reference/impact-stories/attach-authorized-library-files-to-a-story"},{"openapi":"post /admin/impact-stories/intake/slack","title":"Capture a Slack thread permalink as a story draft","href":"/api-reference/impact-stories/capture-a-slack-thread-permalink-as-a-story-draft"},{"openapi":"post /admin/impact-stories/intake/shared-inbox/{conversationId}","title":"Capture a story draft from a shared inbox conversation","href":"/api-reference/impact-stories/capture-a-story-draft-from-a-shared-inbox-conversation"},{"openapi":"post /admin/impact-stories","title":"Create an Impact Story draft","href":"/api-reference/impact-stories/create-an-impact-story-draft"},{"openapi":"post /admin/impact-stories/library-media-drafts","title":"Create an internal story draft from Library files","href":"/api-reference/impact-stories/create-an-internal-story-draft-from-library-files"},{"openapi":"delete /admin/impact-stories/intake-paths/{pathId}","title":"Delete a story intake path","href":"/api-reference/impact-stories/delete-a-story-intake-path"},{"openapi":"get /admin/impact-stories/{storyId}/releases/{releaseId}/download","title":"Download a story consent release","href":"/api-reference/impact-stories/download-a-story-consent-release"},{"openapi":"post /admin/impact-stories/{storyId}/offers","title":"Draft an offer from a story","href":"/api-reference/impact-stories/draft-an-offer-from-a-story"},{"openapi":"get /admin/impact-stories/coverage","title":"Inspect program story coverage","href":"/api-reference/impact-stories/inspect-program-story-coverage"},{"openapi":"get /admin/impact-stories","title":"List governed Impact Stories","href":"/api-reference/impact-stories/list-governed-impact-stories"},{"openapi":"get /admin/impact-stories/import-mappings","title":"List saved story import mappings","href":"/api-reference/impact-stories/list-saved-story-import-mappings"},{"openapi":"get /admin/impact-stories/donors/{donorId}","title":"List stories related to a donor","href":"/api-reference/impact-stories/list-stories-related-to-a-donor"},{"openapi":"get /admin/impact-stories/intake-paths","title":"List story intake paths","href":"/api-reference/impact-stories/list-story-intake-paths"},{"openapi":"get /admin/impact-stories/storage-providers","title":"List story storage provider capabilities","href":"/api-reference/impact-stories/list-story-storage-provider-capabilities"},{"openapi":"get /admin/impact-stories/picker","title":"Pick stories eligible for reuse","href":"/api-reference/impact-stories/pick-stories-eligible-for-reuse"},{"openapi":"post /admin/impact-stories/{storyId}/handoff/{channel}","title":"Prepare an approved story for a destination","href":"/api-reference/impact-stories/prepare-an-approved-story-for-a-destination"},{"openapi":"post /admin/impact-stories/imports/preview","title":"Preview a story import batch","href":"/api-reference/impact-stories/preview-a-story-import-batch"},{"openapi":"get /admin/impact-stories/{storyId}/reuse-preview/{channel}","title":"Preview story reuse for a destination","href":"/api-reference/impact-stories/preview-story-reuse-for-a-destination"},{"openapi":"post /admin/impact-stories/imports/{batchId}/process","title":"Process a previewed story import","href":"/api-reference/impact-stories/process-a-previewed-story-import"},{"openapi":"get /frontend/impact-stories/intake/{slug}","title":"Read a public story intake form","href":"/api-reference/impact-stories/read-a-public-story-intake-form"},{"openapi":"get /admin/impact-stories/imports/{batchId}","title":"Read a story import receipt","href":"/api-reference/impact-stories/read-a-story-import-receipt"},{"openapi":"get /admin/impact-stories/{storyId}","title":"Read an Impact Story","href":"/api-reference/impact-stories/read-an-impact-story"},{"openapi":"get /admin/impact-stories/library-media-context","title":"Read Library media program context","href":"/api-reference/impact-stories/read-library-media-program-context"},{"openapi":"get /frontend/impact-stories/program/{client_id}/{program_id}","title":"Read public stories for a program","href":"/api-reference/impact-stories/read-public-stories-for-a-program"},{"openapi":"post /admin/impact-stories/{storyId}/relations","title":"Relate a record to a story","href":"/api-reference/impact-stories/relate-a-record-to-a-story"},{"openapi":"delete /admin/impact-stories/{storyId}/assets/{storyAssetId}","title":"Remove a story asset","href":"/api-reference/impact-stories/remove-a-story-asset"},{"openapi":"post /admin/impact-stories/{storyId}/request-context","title":"Request context for a story","href":"/api-reference/impact-stories/request-context-for-a-story"},{"openapi":"patch /admin/impact-stories/{storyId}/assets/{storyAssetId}","title":"Review story asset consent and caption","href":"/api-reference/impact-stories/review-story-asset-consent-and-caption"},{"openapi":"post /admin/impact-stories/import-mappings","title":"Save a story import mapping","href":"/api-reference/impact-stories/save-a-story-import-mapping"},{"openapi":"post /admin/impact-stories/intake-paths","title":"Save a story intake path","href":"/api-reference/impact-stories/save-a-story-intake-path"},{"openapi":"put /admin/impact-stories/library-media-context","title":"Save Library media program context","href":"/api-reference/impact-stories/save-library-media-program-context"},{"openapi":"get /admin/impact-stories/related-records","title":"Search records to relate to a story","href":"/api-reference/impact-stories/search-records-to-relate-to-a-story"},{"openapi":"post /admin/impact-stories/{storyId}/submit-review","title":"Submit a story for review","href":"/api-reference/impact-stories/submit-a-story-for-review"},{"openapi":"post /frontend/impact-stories/intake/{slug}","title":"Submit a story with signed consent","href":"/api-reference/impact-stories/submit-a-story-with-signed-consent"},{"openapi":"get /admin/impact-stories/summary","title":"Summarize Impact Stories","href":"/api-reference/impact-stories/summarize-impact-stories"},{"openapi":"patch /admin/impact-stories/{storyId}","title":"Update an Impact Story","href":"/api-reference/impact-stories/update-an-impact-story"}]},{"group":"Integrations","pages":[{"openapi":"post /integrations/hub/connections/{connection_id}/historical-gift-owner-decisions/{conflict_id}/resolve","title":"Apply an imported gift-owner decision","href":"/api-reference/integrations/apply-an-imported-gift-owner-decision"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-donation-owner-decisions/resolve","title":"Apply reviewed outgoing gift-owner matches","href":"/api-reference/integrations/apply-reviewed-outgoing-gift-owner-matches"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-review/apply","title":"Apply reviewed outgoing outcomes without sending","href":"/api-reference/integrations/apply-reviewed-outgoing-outcomes-without-sending"},{"openapi":"post /integrations/hub/connections/{connection_id}/quickbooks/historical/previews/{run_id}/approve","title":"Approve a historical QuickBooks preview","href":"/api-reference/integrations/approve-a-historical-quickbooks-preview"},{"openapi":"post /integrations/hub/field-mappings/{mapping_id}/approve","title":"Approve an integration field mapping","href":"/api-reference/integrations/approve-an-integration-field-mapping"},{"openapi":"get /admin/quickbooks/authorize","title":"Authorize the legacy QuickBooks connection","href":"/api-reference/integrations/authorize-the-legacy-quickbooks-connection"},{"openapi":"post /integrations/hub/providers/blackbaud-raisers-edge/connect","title":"Begin Blackbaud authorization","href":"/api-reference/integrations/begin-blackbaud-authorization"},{"openapi":"post /integrations/hub/providers/hubspot/connect","title":"Begin HubSpot authorization","href":"/api-reference/integrations/begin-hubspot-authorization"},{"openapi":"post /integrations/hub/providers/quickbooks/connect","title":"Begin QuickBooks hub authorization","href":"/api-reference/integrations/begin-quickbooks-hub-authorization"},{"openapi":"post /integrations/hub/providers/{provider_key}/salesforce/connect","title":"Begin Salesforce nonprofit authorization","href":"/api-reference/integrations/begin-salesforce-nonprofit-authorization"},{"openapi":"post /integrations/hub/providers/slack/connect","title":"Begin Slack private-channel authorization","href":"/api-reference/integrations/begin-slack-private-channel-authorization"},{"openapi":"post /integrations/hub/connections/{connection_id}/health-check","title":"Check integration connection health","href":"/api-reference/integrations/check-integration-connection-health"},{"openapi":"get /admin/quickbooks/connection-status","title":"Check legacy QuickBooks connection status","href":"/api-reference/integrations/check-legacy-quickbooks-connection-status"},{"openapi":"post /integrations/handwrytten/readiness","title":"Check the managed handwritten-card connection","href":"/api-reference/integrations/check-the-managed-handwritten-card-connection"},{"openapi":"post /integrations/hub/providers/bloomerang/connect","title":"Connect or reconnect Bloomerang with an API key","href":"/api-reference/integrations/connect-or-reconnect-bloomerang-with-an-api-key"},{"openapi":"post /integrations/hub/connections","title":"Create a Connected Apps connection","href":"/api-reference/integrations/create-a-connected-apps-connection"},{"openapi":"post /integrations/hub/connections/{connection_id}/field-mappings","title":"Create an integration field-mapping draft","href":"/api-reference/integrations/create-an-integration-field-mapping-draft"},{"openapi":"post /integrations/hub/connections/{connection_id}/sync-runs","title":"Create an integration mapping-preview shell","href":"/api-reference/integrations/create-an-integration-mapping-preview-shell"},{"openapi":"post /integrations/hub/providers/sap/connect","title":"Create or refresh an SAP setup workspace","href":"/api-reference/integrations/create-or-refresh-an-sap-setup-workspace"},{"openapi":"delete /integrations/hub/connections/{connection_id}","title":"Disconnect a Connected App","href":"/api-reference/integrations/disconnect-a-connected-app"},{"openapi":"delete /integrations/dropbox-sign/oauth/disconnect","title":"Disconnect Dropbox Sign","href":"/api-reference/integrations/disconnect-dropbox-sign"},{"openapi":"post /integrations/hub/connections/{connection_id}/historical-gift-owner-decisions/discover","title":"Discover imported historical gift-owner mismatches","href":"/api-reference/integrations/discover-imported-historical-gift-owner-mismatches"},{"openapi":"post /integrations/hub/connections/{connection_id}/metadata/discover","title":"Discover integration provider metadata","href":"/api-reference/integrations/discover-integration-provider-metadata"},{"openapi":"get /integrations/hub/connections/{connection_id}/outbound-discovery","title":"Discover local donations missing outgoing capture","href":"/api-reference/integrations/discover-local-donations-missing-outgoing-capture"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/outbound/activate","title":"Enable reviewed future sending to Bloomerang","href":"/api-reference/integrations/enable-reviewed-future-sending-to-bloomerang"},{"openapi":"post /integrations/hub/connections/{connection_id}/sap/bootstrap-mappings","title":"Ensure SAP mapping templates","href":"/api-reference/integrations/ensure-sap-mapping-templates"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-donation-owner-decisions/keep-local","title":"Keep reviewed outgoing gift groups in Gratona","href":"/api-reference/integrations/keep-reviewed-outgoing-gift-groups-in-gratona"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-review/leave-unsent","title":"Leave selected reviewed outgoing donations unsent","href":"/api-reference/integrations/leave-selected-reviewed-outgoing-donations-unsent"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/recipient-mapping","title":"Link a program or recipient to a Bloomerang target","href":"/api-reference/integrations/link-a-program-or-recipient-to-a-bloomerang-target"},{"openapi":"get /integrations/checkr/packages","title":"List available background-check packages","href":"/api-reference/integrations/list-available-background-check-packages"},{"openapi":"get /integrations/hub/providers","title":"List available integration providers","href":"/api-reference/integrations/list-available-integration-providers"},{"openapi":"get /integrations/checkr/geos","title":"List background-check work locations","href":"/api-reference/integrations/list-background-check-work-locations"},{"openapi":"get /integrations/hub/connections","title":"List Connected Apps","href":"/api-reference/integrations/list-connected-apps"},{"openapi":"get /integrations/hub/connections/{connection_id}/donor-identity-decisions","title":"List donor identity decisions","href":"/api-reference/integrations/list-donor-identity-decisions"},{"openapi":"get /integrations/hub/connections/{connection_id}/quickbooks/historical/runs","title":"List historical QuickBooks runs","href":"/api-reference/integrations/list-historical-quickbooks-runs"},{"openapi":"get /integrations/hub/connections/{connection_id}/historical-gift-owner-decisions","title":"List imported historical gift-owner decisions","href":"/api-reference/integrations/list-imported-historical-gift-owner-decisions"},{"openapi":"get /integrations/hub/connections/{connection_id}/conflicts","title":"List integration conflicts","href":"/api-reference/integrations/list-integration-conflicts"},{"openapi":"get /integrations/hub/connections/{connection_id}/field-mappings","title":"List integration field-mapping versions","href":"/api-reference/integrations/list-integration-field-mapping-versions"},{"openapi":"get /integrations/hub/connections/{connection_id}/metadata-snapshots","title":"List integration metadata snapshots","href":"/api-reference/integrations/list-integration-metadata-snapshots"},{"openapi":"get /integrations/hub/connections/{connection_id}/object-mappings","title":"List integration object links","href":"/api-reference/integrations/list-integration-object-links"},{"openapi":"get /integrations/hub/connections/{connection_id}/sync-events","title":"List integration sync events","href":"/api-reference/integrations/list-integration-sync-events"},{"openapi":"get /integrations/hub/connections/{connection_id}/sync-runs","title":"List integration sync runs","href":"/api-reference/integrations/list-integration-sync-runs"},{"openapi":"get /integrations/hub/connections/{connection_id}/quickbooks/issues","title":"List QuickBooks issues or activity","href":"/api-reference/integrations/list-quickbooks-issues-or-activity"},{"openapi":"get /admin/quickbooks/stripe-payouts/accounts","title":"List QuickBooks payout account choices","href":"/api-reference/integrations/list-quickbooks-payout-account-choices"},{"openapi":"get /integrations/hub/connections/{connection_id}/quickbooks/settlement-issues","title":"List QuickBooks settlement issues","href":"/api-reference/integrations/list-quickbooks-settlement-issues"},{"openapi":"get /admin/entities_for_campaign","title":"List recipient QuickBooks class assignments","href":"/api-reference/integrations/list-recipient-quickbooks-class-assignments"},{"openapi":"get /admin/entities_for_campaign/{program_id}","title":"List recipient QuickBooks class assignments for a program","href":"/api-reference/integrations/list-recipient-quickbooks-class-assignments-for-a-program"},{"openapi":"get /integrations/hub/connections/{connection_id}/sync-history","title":"List safe integration sync history","href":"/api-reference/integrations/list-safe-integration-sync-history"},{"openapi":"get /integrations/hub/connections/{connection_id}/webhook-events","title":"List stored integration webhook receipts","href":"/api-reference/integrations/list-stored-integration-webhook-receipts"},{"openapi":"post /integrations/hub/webhook-events/{event_id}/replay","title":"Mark an integration webhook for replay","href":"/api-reference/integrations/mark-an-integration-webhook-for-replay"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/pause","title":"Pause ongoing Bloomerang sync","href":"/api-reference/integrations/pause-ongoing-bloomerang-sync"},{"openapi":"post /admin/quickbooks/stripe-payouts/reconcile","title":"Post a Stripe payout to QuickBooks","href":"/api-reference/integrations/post-a-stripe-payout-to-quickbooks"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/bootstrap-mappings","title":"Prepare Bloomerang mapping templates","href":"/api-reference/integrations/prepare-bloomerang-mapping-templates"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/bootstrap-mappings","title":"Prepare HubSpot mapping templates","href":"/api-reference/integrations/prepare-hubspot-mapping-templates"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/activate","title":"Prepare ongoing Bloomerang sync","href":"/api-reference/integrations/prepare-ongoing-bloomerang-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/bootstrap-mappings","title":"Prepare Salesforce mapping templates","href":"/api-reference/integrations/prepare-salesforce-mapping-templates"},{"openapi":"post /integrations/hub/connections/{connection_id}/quickbooks/historical/runs/{run_id}/correction-preview","title":"Preview a correction to historical QuickBooks sync","href":"/api-reference/integrations/preview-a-correction-to-historical-quickbooks-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/quickbooks/historical/preview","title":"Preview a historical QuickBooks sync","href":"/api-reference/integrations/preview-a-historical-quickbooks-sync"},{"openapi":"post /admin/quickbooks/stripe-payouts/preview","title":"Preview a Stripe payout reconciliation","href":"/api-reference/integrations/preview-a-stripe-payout-reconciliation"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/preview","title":"Preview ongoing Bloomerang sync preparation","href":"/api-reference/integrations/preview-ongoing-bloomerang-sync-preparation"},{"openapi":"get /integrations/hub/connections/{connection_id}/outbound-review","title":"Preview outgoing Bloomerang donation review","href":"/api-reference/integrations/preview-outgoing-bloomerang-donation-review"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/dry-run","title":"Queue a Bloomerang inbound preview","href":"/api-reference/integrations/queue-a-bloomerang-inbound-preview"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/import","title":"Queue a manual Bloomerang import","href":"/api-reference/integrations/queue-a-manual-bloomerang-import"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/poll","title":"Queue a reviewed ongoing Bloomerang poll","href":"/api-reference/integrations/queue-a-reviewed-ongoing-bloomerang-poll"},{"openapi":"post /integrations/hub/sync-events/{event_id}/retry","title":"Queue an eligible outgoing integration retry","href":"/api-reference/integrations/queue-an-eligible-outgoing-integration-retry"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/poll","title":"Queue an inbound HubSpot poll","href":"/api-reference/integrations/queue-an-inbound-hubspot-poll"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/poll","title":"Queue an inbound Salesforce poll","href":"/api-reference/integrations/queue-an-inbound-salesforce-poll"},{"openapi":"post /admin/sync_donor_to_quickbooks","title":"Queue donors for QuickBooks customer sync","href":"/api-reference/integrations/queue-donors-for-quickbooks-customer-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/reconcile","title":"Queue HubSpot metadata reconciliation","href":"/api-reference/integrations/queue-hubspot-metadata-reconciliation"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/outbound-sync","title":"Queue HubSpot outgoing sync","href":"/api-reference/integrations/queue-hubspot-outgoing-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/outbound-sync","title":"Queue outgoing Salesforce nonprofit sync","href":"/api-reference/integrations/queue-outgoing-salesforce-nonprofit-sync"},{"openapi":"post /admin/sync_entity_to_quickbooks","title":"Queue recipients for QuickBooks service item sync","href":"/api-reference/integrations/queue-recipients-for-quickbooks-service-item-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/outbound-sync","title":"Queue reviewed outgoing Bloomerang sync","href":"/api-reference/integrations/queue-reviewed-outgoing-bloomerang-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/reconcile","title":"Queue Salesforce metadata reconciliation","href":"/api-reference/integrations/queue-salesforce-metadata-reconciliation"},{"openapi":"post /integrations/hub/connections/{connection_id}/sap/reconcile","title":"Queue SAP metadata reconciliation","href":"/api-reference/integrations/queue-sap-metadata-reconciliation"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-review/send","title":"Queue selected reviewed donations for sending","href":"/api-reference/integrations/queue-selected-reviewed-donations-for-sending"},{"openapi":"get /integrations/hub/connections/{connection_id}","title":"Read a Connected Apps connection","href":"/api-reference/integrations/read-a-connected-apps-connection"},{"openapi":"get /integrations/hub/connections/{connection_id}/quickbooks/historical/runs/{run_id}","title":"Read a historical QuickBooks run","href":"/api-reference/integrations/read-a-historical-quickbooks-run"},{"openapi":"get /integrations/hub/sync-runs/{run_id}","title":"Read an integration sync run","href":"/api-reference/integrations/read-an-integration-sync-run"},{"openapi":"get /integrations/hub/connections/{connection_id}/bloomerang/mapping-options","title":"Read Bloomerang mapping options","href":"/api-reference/integrations/read-bloomerang-mapping-options"},{"openapi":"get /integrations/hub/connections/{connection_id}/hubspot/mapping-options","title":"Read HubSpot mapping options","href":"/api-reference/integrations/read-hubspot-mapping-options"},{"openapi":"get /admin/fields_to_attach","title":"Read QuickBooks accounting attachment settings","href":"/api-reference/integrations/read-quickbooks-accounting-attachment-settings"},{"openapi":"get /admin/fields_to_attach/{program_id}","title":"Read QuickBooks accounting attachment settings for a program","href":"/api-reference/integrations/read-quickbooks-accounting-attachment-settings-for-a-program"},{"openapi":"get /admin/fields_to_sync","title":"Read QuickBooks customer field mappings","href":"/api-reference/integrations/read-quickbooks-customer-field-mappings"},{"openapi":"get /admin/fields_to_sync/{program_id}","title":"Read QuickBooks customer field mappings for a program","href":"/api-reference/integrations/read-quickbooks-customer-field-mappings-for-a-program"},{"openapi":"get /admin/quickbooks/delete-sync-settings","title":"Read QuickBooks deletion sync settings","href":"/api-reference/integrations/read-quickbooks-deletion-sync-settings"},{"openapi":"get /admin/quickbooks/customer-sync-settings","title":"Read QuickBooks duplicate customer policy","href":"/api-reference/integrations/read-quickbooks-duplicate-customer-policy"},{"openapi":"get /admin/program_fields_to_sync","title":"Read QuickBooks service item field mappings","href":"/api-reference/integrations/read-quickbooks-service-item-field-mappings"},{"openapi":"get /admin/program_fields_to_sync/{program_id}","title":"Read QuickBooks service item field mappings for a program","href":"/api-reference/integrations/read-quickbooks-service-item-field-mappings-for-a-program"},{"openapi":"get /admin/quickbooks/stripe-payouts/settings","title":"Read QuickBooks Stripe-payout settings","href":"/api-reference/integrations/read-quickbooks-stripe-payout-settings"},{"openapi":"get /admin/quickbooks/sync-direction","title":"Read QuickBooks sync direction","href":"/api-reference/integrations/read-quickbooks-sync-direction"},{"openapi":"get /admin/quickbooks/stripe-payouts/history","title":"Read recent Stripe payout reconciliations","href":"/api-reference/integrations/read-recent-stripe-payout-reconciliations"},{"openapi":"get /integrations/hub/connections/{connection_id}/sync-history/{run_id}/events","title":"Read safe events and readiness for an integration run","href":"/api-reference/integrations/read-safe-events-and-readiness-for-an-integration-run"},{"openapi":"get /integrations/hub/connections/{connection_id}/salesforce/mapping-options","title":"Read Salesforce nonprofit mapping options","href":"/api-reference/integrations/read-salesforce-nonprofit-mapping-options"},{"openapi":"get /admin/quickbooks/organization","title":"Read the connected QuickBooks company name","href":"/api-reference/integrations/read-the-connected-quickbooks-company-name"},{"openapi":"post /integrations/hub/connections/{connection_id}/conflicts","title":"Record an integration conflict","href":"/api-reference/integrations/record-an-integration-conflict"},{"openapi":"post /integrations/hub/providers/zapier/connect","title":"Register a Zapier Connected App","href":"/api-reference/integrations/register-a-zapier-connected-app"},{"openapi":"delete /integrations/hub/connections/{connection_id}/bloomerang/recipient-mapping/{mapping_id}","title":"Remove a Bloomerang program or recipient link","href":"/api-reference/integrations/remove-a-bloomerang-program-or-recipient-link"},{"openapi":"delete /integrations/hub/connections/{connection_id}/remove","title":"Remove a disconnected Connected App","href":"/api-reference/integrations/remove-a-disconnected-connected-app"},{"openapi":"delete /admin/quickbooks/disconnect","title":"Remove the legacy QuickBooks integration","href":"/api-reference/integrations/remove-the-legacy-quickbooks-integration"},{"openapi":"post /integrations/hub/connections/{connection_id}/reauthorize","title":"Replace integration credentials","href":"/api-reference/integrations/replace-integration-credentials"},{"openapi":"post /integrations/hub/providers/twilio/link","title":"Request a WhatsApp staff-link code","href":"/api-reference/integrations/request-a-whatsapp-staff-link-code"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/restore","title":"Reset ongoing sync and restore prior safeguards","href":"/api-reference/integrations/reset-ongoing-sync-and-restore-prior-safeguards"},{"openapi":"post /integrations/hub/connections/{connection_id}/donor-identity-decisions/{event_id}/resolve","title":"Resolve a reviewed donor identity collision","href":"/api-reference/integrations/resolve-a-reviewed-donor-identity-collision"},{"openapi":"post /integrations/hub/connections/{connection_id}/quickbooks/historical/runs/{run_id}/resume","title":"Resume a historical QuickBooks execution","href":"/api-reference/integrations/resume-a-historical-quickbooks-execution"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/resume","title":"Resume reviewed inbound Bloomerang sync","href":"/api-reference/integrations/resume-reviewed-inbound-bloomerang-sync"},{"openapi":"post /integrations/hub/connections/{connection_id}/quickbooks/historical/runs/{run_id}/events/{event_id}/retry","title":"Retry a historical QuickBooks checkpoint","href":"/api-reference/integrations/retry-a-historical-quickbooks-checkpoint"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/ongoing-sync/outbound/preview","title":"Review future sending to Bloomerang","href":"/api-reference/integrations/review-future-sending-to-bloomerang"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/dry-run","title":"Review HubSpot mapping and import readiness","href":"/api-reference/integrations/review-hubspot-mapping-and-import-readiness"},{"openapi":"get /integrations/hub/connections/{connection_id}/outbound-donation-owner-decisions","title":"Review outgoing donations owned by archived donors","href":"/api-reference/integrations/review-outgoing-donations-owned-by-archived-donors"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/dry-run","title":"Review Salesforce mapping readiness","href":"/api-reference/integrations/review-salesforce-mapping-readiness"},{"openapi":"post /integrations/hub/connections/{connection_id}/sap/dry-run","title":"Review SAP export readiness","href":"/api-reference/integrations/review-sap-export-readiness"},{"openapi":"put /admin/program_item_category/{program_id}","title":"Save a program QuickBooks item category","href":"/api-reference/integrations/save-a-program-quickbooks-item-category"},{"openapi":"post /integrations/hub/conflicts/{conflict_id}/resolve","title":"Save an integration conflict decision","href":"/api-reference/integrations/save-an-integration-conflict-decision"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/contact-donor-mapping","title":"Save Bloomerang constituent-to-donor mapping","href":"/api-reference/integrations/save-bloomerang-constituent-to-donor-mapping"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/group-mapping","title":"Save Bloomerang group tag import","href":"/api-reference/integrations/save-bloomerang-group-tag-import"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/household-mapping","title":"Save Bloomerang household setup","href":"/api-reference/integrations/save-bloomerang-household-setup"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/interaction-mapping","title":"Save Bloomerang interaction and note settings","href":"/api-reference/integrations/save-bloomerang-interaction-and-note-settings"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/relationship-mapping","title":"Save Bloomerang relationship setup","href":"/api-reference/integrations/save-bloomerang-relationship-setup"},{"openapi":"post /integrations/hub/connections/{connection_id}/bloomerang/donation-mapping","title":"Save Bloomerang transaction setup","href":"/api-reference/integrations/save-bloomerang-transaction-setup"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/activity-mapping","title":"Save HubSpot activity sync settings","href":"/api-reference/integrations/save-hubspot-activity-sync-settings"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/company-mapping","title":"Save HubSpot company mapping","href":"/api-reference/integrations/save-hubspot-company-mapping"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/contact-donor-mapping","title":"Save HubSpot contact-to-donor fields","href":"/api-reference/integrations/save-hubspot-contact-to-donor-fields"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/deal-mapping","title":"Save HubSpot deal import settings","href":"/api-reference/integrations/save-hubspot-deal-import-settings"},{"openapi":"post /integrations/hub/connections/{connection_id}/hubspot/product-mapping","title":"Save HubSpot product and outbound deal settings","href":"/api-reference/integrations/save-hubspot-product-and-outbound-deal-settings"},{"openapi":"post /admin/quickbooks/donorform","title":"Save legacy QuickBooks form assignments","href":"/api-reference/integrations/save-legacy-quickbooks-form-assignments"},{"openapi":"post /admin/fields_to_attach","title":"Save QuickBooks accounting attachment settings","href":"/api-reference/integrations/save-quickbooks-accounting-attachment-settings"},{"openapi":"post /admin/fields_to_attach/{program_id}","title":"Save QuickBooks accounting attachment settings for a program","href":"/api-reference/integrations/save-quickbooks-accounting-attachment-settings-for-a-program"},{"openapi":"post /admin/fields_to_sync","title":"Save QuickBooks customer field mappings","href":"/api-reference/integrations/save-quickbooks-customer-field-mappings"},{"openapi":"post /admin/fields_to_sync/{program_id}","title":"Save QuickBooks customer field mappings for a program","href":"/api-reference/integrations/save-quickbooks-customer-field-mappings-for-a-program"},{"openapi":"put /admin/quickbooks/delete-sync-settings","title":"Save QuickBooks deletion sync settings","href":"/api-reference/integrations/save-quickbooks-deletion-sync-settings"},{"openapi":"put /admin/quickbooks/customer-sync-settings","title":"Save QuickBooks duplicate customer policy","href":"/api-reference/integrations/save-quickbooks-duplicate-customer-policy"},{"openapi":"put /admin/fields_to_attach","title":"Save QuickBooks recipient class assignments","href":"/api-reference/integrations/save-quickbooks-recipient-class-assignments"},{"openapi":"put /admin/fields_to_attach/{program_id}","title":"Save QuickBooks recipient class assignments for a program","href":"/api-reference/integrations/save-quickbooks-recipient-class-assignments-for-a-program"},{"openapi":"post /admin/program_fields_to_sync","title":"Save QuickBooks service item field mappings","href":"/api-reference/integrations/save-quickbooks-service-item-field-mappings"},{"openapi":"post /admin/program_fields_to_sync/{program_id}","title":"Save QuickBooks service item field mappings for a program","href":"/api-reference/integrations/save-quickbooks-service-item-field-mappings-for-a-program"},{"openapi":"put /admin/quickbooks/sync-direction","title":"Save QuickBooks sync direction","href":"/api-reference/integrations/save-quickbooks-sync-direction"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/donation-mapping","title":"Save Salesforce donation sync directions","href":"/api-reference/integrations/save-salesforce-donation-sync-directions"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/contact-donor-mapping","title":"Save Salesforce donor field mapping","href":"/api-reference/integrations/save-salesforce-donor-field-mapping"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/interaction-mapping","title":"Save Salesforce interaction sync settings","href":"/api-reference/integrations/save-salesforce-interaction-sync-settings"},{"openapi":"post /integrations/hub/connections/{connection_id}/salesforce/recipient-mapping","title":"Save Salesforce recipient field mapping","href":"/api-reference/integrations/save-salesforce-recipient-field-mapping"},{"openapi":"get /integrations/hub/connections/{connection_id}/bloomerang/fallback-designations","title":"Search donation fallback recipients","href":"/api-reference/integrations/search-donation-fallback-recipients"},{"openapi":"get /admin/quickbooks/designation-revenue-targets/{program_id}","title":"Search QuickBooks revenue mapping targets","href":"/api-reference/integrations/search-quickbooks-revenue-mapping-targets"},{"openapi":"get /admin/quickbooks/items/search","title":"Search QuickBooks service items","href":"/api-reference/integrations/search-quickbooks-service-items"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-discovery/stage","title":"Stage discovered donations for outgoing review","href":"/api-reference/integrations/stage-discovered-donations-for-outgoing-review"},{"openapi":"get /integrations/dropbox-sign/oauth/connect","title":"Start Dropbox Sign authorization","href":"/api-reference/integrations/start-dropbox-sign-authorization"},{"openapi":"post /integrations/hub/connections/{connection_id}/webhook-events","title":"Store an integration webhook receipt","href":"/api-reference/integrations/store-an-integration-webhook-receipt"},{"openapi":"post /integrations/hub/connections/{connection_id}/outbound-donation-owner-resolutions/{run_id}/undo","title":"Undo a local gift-owner or keep-local decision","href":"/api-reference/integrations/undo-a-local-gift-owner-or-keep-local-decision"},{"openapi":"patch /integrations/hub/connections/{connection_id}","title":"Update a Connected Apps connection","href":"/api-reference/integrations/update-a-connected-apps-connection"},{"openapi":"put /admin/quickbooks/stripe-payouts/settings","title":"Update QuickBooks Stripe-payout settings","href":"/api-reference/integrations/update-quickbooks-stripe-payout-settings"},{"openapi":"post /integrations/hub/connections/{connection_id}/object-mappings","title":"Upsert an integration object link","href":"/api-reference/integrations/upsert-an-integration-object-link"},{"openapi":"post /integrations/hub/conflicts/{conflict_id}/verify-recurring-schedule","title":"Verify a recurring-schedule decision","href":"/api-reference/integrations/verify-a-recurring-schedule-decision"},{"openapi":"post /integrations/hub/providers/twilio/link/verify","title":"Verify a WhatsApp staff-link code","href":"/api-reference/integrations/verify-a-whatsapp-staff-link-code"},{"openapi":"post /integrations/hub/conflicts/{conflict_id}/verify-relationship-identity","title":"Verify and apply a staged relationship decision","href":"/api-reference/integrations/verify-and-apply-a-staged-relationship-decision"}]},{"group":"Intelligence","pages":[{"openapi":"post /admin/workspace-agent/runs","title":"Append a message and start an agent run","href":"/api-reference/intelligence/append-a-message-and-start-an-agent-run"},{"openapi":"post /admin/aida/work-items/{workItemId}/approve","title":"Approve and execute a Tali draft","href":"/api-reference/intelligence/approve-and-execute-a-tali-draft"},{"openapi":"post /admin/workspace-agent/runs/{run}/cancel","title":"Cancel a workspace-agent run","href":"/api-reference/intelligence/cancel-a-workspace-agent-run"},{"openapi":"post /admin/workspace-agent/interrupts/{interrupt}/cancel","title":"Cancel an agent human-input interrupt","href":"/api-reference/intelligence/cancel-an-agent-human-input-interrupt"},{"openapi":"post /admin/aida/capture","title":"Capture a relationship note for Tali","href":"/api-reference/intelligence/capture-a-relationship-note-for-tali"},{"openapi":"post /admin/aida/work-items/{workItemId}/defer","title":"Defer Tali work","href":"/api-reference/intelligence/defer-tali-work"},{"openapi":"delete /admin/workspace-agent/conversations/{conversation}","title":"Delete a workspace-agent conversation","href":"/api-reference/intelligence/delete-a-workspace-agent-conversation"},{"openapi":"delete /admin/aida/relationship-memories/{memoryId}","title":"Delete relationship memory","href":"/api-reference/intelligence/delete-relationship-memory"},{"openapi":"get /admin/donor-intelligence/{client_id}/donors/exports/{uploadId}","title":"Download a completed donor intelligence export","href":"/api-reference/intelligence/download-a-completed-donor-intelligence-export"},{"openapi":"get /admin/wealth-insights/{client_id}/donors/exports/{uploadId}","title":"Download a completed donor intelligence export","href":"/api-reference/intelligence/download-a-completed-donor-intelligence-export-1"},{"openapi":"get /admin/workspace-agent/conversations/{conversation}/export","title":"Download a conversation JSON Lines export","href":"/api-reference/intelligence/download-a-conversation-json-lines-export"},{"openapi":"get /admin/workspace-agent/artifacts/{artifact}/content","title":"Download authorized agent artifact content","href":"/api-reference/intelligence/download-authorized-agent-artifact-content"},{"openapi":"patch /admin/aida/work-items/{workItemId}/draft","title":"Edit a Tali review draft","href":"/api-reference/intelligence/edit-a-tali-review-draft"},{"openapi":"post /admin/aida/work-items/{workItemId}/link-donor","title":"Link Tali work to an existing donor","href":"/api-reference/intelligence/link-tali-work-to-an-existing-donor"},{"openapi":"get /admin/workspace-agent/agents","title":"List available workspace agents","href":"/api-reference/intelligence/list-available-workspace-agents"},{"openapi":"get /admin/workspace-agent/conversations/{conversation}/messages","title":"List conversation messages after a sequence","href":"/api-reference/intelligence/list-conversation-messages-after-a-sequence"},{"openapi":"get /admin/donor-intelligence/{client_id}/donors","title":"List donor intelligence prospect rows","href":"/api-reference/intelligence/list-donor-intelligence-prospect-rows"},{"openapi":"get /admin/wealth-insights/{client_id}/donors","title":"List donor intelligence prospect rows","href":"/api-reference/intelligence/list-donor-intelligence-prospect-rows-1"},{"openapi":"get /admin/workspace-agent/conversations","title":"List my workspace-agent conversations","href":"/api-reference/intelligence/list-my-workspace-agent-conversations"},{"openapi":"get /admin/aida/runs","title":"List recent Tali source sweeps","href":"/api-reference/intelligence/list-recent-tali-source-sweeps"},{"openapi":"get /admin/workspace-agent/runs/{run}/trajectory","title":"List run events after a sequence","href":"/api-reference/intelligence/list-run-events-after-a-sequence"},{"openapi":"patch /admin/aida/work-items/{workItemId}/pipeline-stage","title":"Move a relationship pipeline stage","href":"/api-reference/intelligence/move-a-relationship-pipeline-stage"},{"openapi":"post /admin/donor-intelligence/generations/bulk","title":"Preview or queue bulk donor profile generation","href":"/api-reference/intelligence/preview-or-queue-bulk-donor-profile-generation"},{"openapi":"post /admin/wealth-insights/generations/bulk","title":"Preview or queue bulk donor profile generation","href":"/api-reference/intelligence/preview-or-queue-bulk-donor-profile-generation-1"},{"openapi":"post /admin/ai-capacity/top-ups","title":"Purchase shared workspace AI capacity","href":"/api-reference/intelligence/purchase-shared-workspace-ai-capacity"},{"openapi":"get /admin/donor-intelligence/{client_id}/donors/export","title":"Queue a donor intelligence CSV export","href":"/api-reference/intelligence/queue-a-donor-intelligence-csv-export"},{"openapi":"get /admin/wealth-insights/{client_id}/donors/export","title":"Queue a donor intelligence CSV export","href":"/api-reference/intelligence/queue-a-donor-intelligence-csv-export-1"},{"openapi":"post /admin/donors/{donor_id}/donor-intelligence/generate","title":"Queue a donor intelligence profile generation","href":"/api-reference/intelligence/queue-a-donor-intelligence-profile-generation"},{"openapi":"post /admin/donors/{donor_id}/wealth-insights/generate","title":"Queue a donor intelligence profile generation","href":"/api-reference/intelligence/queue-a-donor-intelligence-profile-generation-1"},{"openapi":"get /admin/workspace-agent/interrupts/{interrupt}","title":"Read a human-input interrupt","href":"/api-reference/intelligence/read-a-human-input-interrupt"},{"openapi":"get /admin/aida/work-items/{workItemId}","title":"Read a Tali work item","href":"/api-reference/intelligence/read-a-tali-work-item"},{"openapi":"get /admin/workspace-agent/conversations/{conversation}","title":"Read a workspace-agent conversation","href":"/api-reference/intelligence/read-a-workspace-agent-conversation"},{"openapi":"get /admin/workspace-agent/artifacts/{artifact}","title":"Read agent artifact metadata","href":"/api-reference/intelligence/read-agent-artifact-metadata"},{"openapi":"get /admin/workspace-agent/runs/{run}","title":"Read an agent run","href":"/api-reference/intelligence/read-an-agent-run"},{"openapi":"get /admin/donor-intelligence/generations/bulk/{bulk_generation_id}","title":"Read bulk donor generation progress","href":"/api-reference/intelligence/read-bulk-donor-generation-progress"},{"openapi":"get /admin/wealth-insights/generations/bulk/{bulk_generation_id}","title":"Read bulk donor generation progress","href":"/api-reference/intelligence/read-bulk-donor-generation-progress-1"},{"openapi":"get /admin/donor-intelligence/{client_id}/usage","title":"Read donor intelligence adoption over thirty days","href":"/api-reference/intelligence/read-donor-intelligence-adoption-over-thirty-days"},{"openapi":"get /admin/wealth-insights/{client_id}/usage","title":"Read donor intelligence adoption over thirty days","href":"/api-reference/intelligence/read-donor-intelligence-adoption-over-thirty-days-1"},{"openapi":"get /admin/donor-intelligence/{client_id}/summary","title":"Read Donor Intelligence coverage and capacity summary","href":"/api-reference/intelligence/read-donor-intelligence-coverage-and-capacity-summary"},{"openapi":"get /admin/wealth-insights/{client_id}/summary","title":"Read Donor Intelligence coverage and capacity summary","href":"/api-reference/intelligence/read-donor-intelligence-coverage-and-capacity-summary-1"},{"openapi":"get /admin/donor-intelligence/{client_id}/settings","title":"Read Donor Intelligence dashboard settings","href":"/api-reference/intelligence/read-donor-intelligence-dashboard-settings"},{"openapi":"get /admin/wealth-insights/{client_id}/settings","title":"Read Donor Intelligence dashboard settings","href":"/api-reference/intelligence/read-donor-intelligence-dashboard-settings-1"},{"openapi":"get /admin/donor-intelligence/{client_id}/donors/exports/{uploadId}/status","title":"Read donor intelligence export progress","href":"/api-reference/intelligence/read-donor-intelligence-export-progress"},{"openapi":"get /admin/wealth-insights/{client_id}/donors/exports/{uploadId}/status","title":"Read donor intelligence export progress","href":"/api-reference/intelligence/read-donor-intelligence-export-progress-1"},{"openapi":"get /admin/donors/{donor_id}/donor-intelligence/generations/{generation_id}","title":"Read donor profile generation status","href":"/api-reference/intelligence/read-donor-profile-generation-status"},{"openapi":"get /admin/donors/{donor_id}/wealth-insights/generations/{generation_id}","title":"Read donor profile generation status","href":"/api-reference/intelligence/read-donor-profile-generation-status-1"},{"openapi":"get /admin/donors/{client_id}/donor-intelligence","title":"Read my donor intelligence usage status","href":"/api-reference/intelligence/read-my-donor-intelligence-usage-status"},{"openapi":"get /admin/donors/{client_id}/wealth-insights","title":"Read my donor intelligence usage status","href":"/api-reference/intelligence/read-my-donor-intelligence-usage-status-1"},{"openapi":"get /admin/ai-capacity/summary","title":"Read shared workspace AI capacity","href":"/api-reference/intelligence/read-shared-workspace-ai-capacity"},{"openapi":"get /admin/aida/settings","title":"Read Tali workspace policy settings","href":"/api-reference/intelligence/read-tali-workspace-policy-settings"},{"openapi":"get /admin/donor-intelligence/{client_id}/donors/{donor_id}/latest","title":"Read the latest stored donor intelligence profile","href":"/api-reference/intelligence/read-the-latest-stored-donor-intelligence-profile"},{"openapi":"get /admin/wealth-insights/{client_id}/donors/{donor_id}/latest","title":"Read the latest stored donor intelligence profile","href":"/api-reference/intelligence/read-the-latest-stored-donor-intelligence-profile-1"},{"openapi":"get /admin/donors/{client_id}/donor-intelligence/{donor_id}","title":"Read the latest stored donor intelligence profile","href":"/api-reference/intelligence/read-the-latest-stored-donor-intelligence-profile-2"},{"openapi":"get /admin/donors/{client_id}/wealth-insights/{donor_id}","title":"Read the latest stored donor intelligence profile","href":"/api-reference/intelligence/read-the-latest-stored-donor-intelligence-profile-3"},{"openapi":"get /admin/aida/workspace","title":"Read the Tali work review workspace","href":"/api-reference/intelligence/read-the-tali-work-review-workspace"},{"openapi":"get /admin/donors/{client_id}/distinct-usage-insights","title":"Read workspace donor intelligence usage","href":"/api-reference/intelligence/read-workspace-donor-intelligence-usage"},{"openapi":"post /admin/aida/recall","title":"Recall approved relationship source evidence","href":"/api-reference/intelligence/recall-approved-relationship-source-evidence"},{"openapi":"post /admin/aida/work-items/{workItemId}/source-change","title":"Record a source change on Tali work","href":"/api-reference/intelligence/record-a-source-change-on-tali-work"},{"openapi":"post /admin/workspace-agent/runs/{run}/feedback","title":"Record feedback for an agent run","href":"/api-reference/intelligence/record-feedback-for-an-agent-run"},{"openapi":"post /admin/aida/work-items/{workItemId}/refresh-draft","title":"Refresh a stale Tali draft","href":"/api-reference/intelligence/refresh-a-stale-tali-draft"},{"openapi":"post /admin/aida/work-items/{workItemId}/reject","title":"Reject Tali work","href":"/api-reference/intelligence/reject-tali-work"},{"openapi":"patch /admin/workspace-agent/conversations/{conversation}","title":"Rename, archive or restore a conversation","href":"/api-reference/intelligence/rename-archive-or-restore-a-conversation"},{"openapi":"post /admin/aida/work-items/{workItemId}/request-context","title":"Request missing context for Tali work","href":"/api-reference/intelligence/request-missing-context-for-tali-work"},{"openapi":"post /admin/workspace-agent/interrupts/{interrupt}/resolve","title":"Resolve an agent human-input interrupt","href":"/api-reference/intelligence/resolve-an-agent-human-input-interrupt"},{"openapi":"post /admin/aida/work-items/{workItemId}/resolve-match","title":"Resolve an ambiguous Tali relationship","href":"/api-reference/intelligence/resolve-an-ambiguous-tali-relationship"},{"openapi":"post /admin/aida/runs/retry","title":"Run an approved-source work sweep","href":"/api-reference/intelligence/run-an-approved-source-work-sweep"},{"openapi":"post /admin/donors/donor-intelligence/{donor_id}","title":"Save an authored donor intelligence profile","href":"/api-reference/intelligence/save-an-authored-donor-intelligence-profile"},{"openapi":"post /admin/donors/wealth-insights/{donor_id}","title":"Save an authored donor intelligence profile","href":"/api-reference/intelligence/save-an-authored-donor-intelligence-profile-1"},{"openapi":"get /admin/aida/relationship-matches","title":"Search donor records for a Tali relationship","href":"/api-reference/intelligence/search-donor-records-for-a-tali-relationship"},{"openapi":"get /admin/workspace-agent/runs/{run}/events","title":"Stream workspace-agent run events","href":"/api-reference/intelligence/stream-workspace-agent-run-events"},{"openapi":"post /admin/aida/work-items/{workItemId}/suppress","title":"Suppress Tali work","href":"/api-reference/intelligence/suppress-tali-work"},{"openapi":"post /admin/aida/transcribe","title":"Transcribe a Tali voice note","href":"/api-reference/intelligence/transcribe-a-tali-voice-note"},{"openapi":"post /frontend/translate/{client_id}","title":"Translate text for a public organization","href":"/api-reference/intelligence/translate-text-for-a-public-organization"},{"openapi":"post /admin/translate","title":"Translate workspace text","href":"/api-reference/intelligence/translate-workspace-text"},{"openapi":"put /admin/donor-intelligence/{client_id}/settings","title":"Update Donor Intelligence dashboard settings","href":"/api-reference/intelligence/update-donor-intelligence-dashboard-settings"},{"openapi":"put /admin/wealth-insights/{client_id}/settings","title":"Update Donor Intelligence dashboard settings","href":"/api-reference/intelligence/update-donor-intelligence-dashboard-settings-1"},{"openapi":"patch /admin/aida/relationship-memories/{memoryId}","title":"Update relationship memory","href":"/api-reference/intelligence/update-relationship-memory"},{"openapi":"put /admin/aida/settings","title":"Update Tali workspace policy settings","href":"/api-reference/intelligence/update-tali-workspace-policy-settings"},{"openapi":"post /admin/donors/{client_id}/donor-intelligence/subscription","title":"Update workspace donor intelligence subscription metadata","href":"/api-reference/intelligence/update-workspace-donor-intelligence-subscription-metadata"},{"openapi":"post /admin/donors/{client_id}/wealth-insights/subscription","title":"Update workspace donor intelligence subscription metadata","href":"/api-reference/intelligence/update-workspace-donor-intelligence-subscription-metadata-1"}]},{"group":"Journeys","pages":[{"openapi":"post /admin/journeys/{id}/activate","title":"Activate a journey","href":"/api-reference/journeys/activate-a-journey"},{"openapi":"post /admin/journeys/system-automations/convert","title":"Copy a system automation into a journey draft","href":"/api-reference/journeys/copy-a-system-automation-into-a-journey-draft"},{"openapi":"post /admin/journeys","title":"Create a journey draft","href":"/api-reference/journeys/create-a-journey-draft"},{"openapi":"post /admin/journeys/message-templates","title":"Create a journey message template","href":"/api-reference/journeys/create-a-journey-message-template"},{"openapi":"post /admin/journeys/event-follow-ups/{eventId}","title":"Create an event interest follow-up draft","href":"/api-reference/journeys/create-an-event-interest-follow-up-draft"},{"openapi":"delete /admin/journeys/{id}","title":"Delete a journey","href":"/api-reference/journeys/delete-a-journey"},{"openapi":"post /admin/journeys/{id}/duplicate","title":"Duplicate a journey into a draft","href":"/api-reference/journeys/duplicate-a-journey-into-a-draft"},{"openapi":"get /admin/journeys/{id}","title":"Get a journey graph","href":"/api-reference/journeys/get-a-journey-graph"},{"openapi":"get /admin/journeys/message-templates/{channel}/{id}","title":"Get a journey message template","href":"/api-reference/journeys/get-a-journey-message-template"},{"openapi":"get /admin/journeys/options","title":"Get journey editor options","href":"/api-reference/journeys/get-journey-editor-options"},{"openapi":"get /admin/journeys/{id}/stats","title":"Get journey execution statistics","href":"/api-reference/journeys/get-journey-execution-statistics"},{"openapi":"get /admin/journeys/event-follow-ups/{eventId}","title":"List event follow-up journeys","href":"/api-reference/journeys/list-event-follow-up-journeys"},{"openapi":"get /admin/journeys/{id}/enrollments","title":"List journey enrollments","href":"/api-reference/journeys/list-journey-enrollments"},{"openapi":"get /admin/journeys/message-templates","title":"List journey message templates","href":"/api-reference/journeys/list-journey-message-templates"},{"openapi":"get /admin/journeys","title":"List journeys","href":"/api-reference/journeys/list-journeys"},{"openapi":"get /admin/journeys/system-automations","title":"List legacy system automations","href":"/api-reference/journeys/list-legacy-system-automations"},{"openapi":"post /admin/journeys/{id}/pause","title":"Pause a journey","href":"/api-reference/journeys/pause-a-journey"},{"openapi":"post /admin/journeys/message-templates/provision","title":"Provision starter journey templates","href":"/api-reference/journeys/provision-starter-journey-templates"},{"openapi":"post /admin/journeys/{id}/steps","title":"Replace a draft journey graph","href":"/api-reference/journeys/replace-a-draft-journey-graph"},{"openapi":"put /admin/journeys/message-templates/{channel}/{id}","title":"Update a shared journey message template","href":"/api-reference/journeys/update-a-shared-journey-message-template"},{"openapi":"put /admin/journeys/{id}","title":"Update journey details","href":"/api-reference/journeys/update-journey-details"}]},{"group":"Library","pages":[{"openapi":"post /admin/workspace-library/upload-admissions","title":"Authorize an immutable Library source upload","href":"/api-reference/library/authorize-an-immutable-library-source-upload"},{"openapi":"get /admin/workspace-library/drive/connections/{connection}/folders","title":"Browse folders in an owned Drive account","href":"/api-reference/library/browse-folders-in-an-owned-drive-account"},{"openapi":"post /admin/workspace-library/drive/connections/{connection}/complete","title":"Complete a Google Drive connection","href":"/api-reference/library/complete-a-google-drive-connection"},{"openapi":"patch /admin/workspace-library/files/{file}/analysis","title":"Correct a current image description and tags","href":"/api-reference/library/correct-a-current-image-description-and-tags"},{"openapi":"post /admin/workspace-library/files/{file}/stories","title":"Create a draft story from a Library file","href":"/api-reference/library/create-a-draft-story-from-a-library-file"},{"openapi":"post /admin/workspace-library/file-collections","title":"Create a personal Library collection","href":"/api-reference/library/create-a-personal-library-collection"},{"openapi":"post /admin/workspace-library/documents","title":"Create canonical Library document metadata","href":"/api-reference/library/create-canonical-library-document-metadata"},{"openapi":"delete /admin/workspace-library/file-collections/{collection}","title":"Delete a personal Library collection","href":"/api-reference/library/delete-a-personal-library-collection"},{"openapi":"delete /admin/workspace-library/file-views/{viewId}","title":"Delete a personal Library filter view","href":"/api-reference/library/delete-a-personal-library-filter-view"},{"openapi":"post /admin/workspace-library/drive/connections/{connection}/disconnect","title":"Disconnect an owned Drive account","href":"/api-reference/library/disconnect-an-owned-drive-account"},{"openapi":"get /admin/workspace-library/file-filter-fields","title":"Discover available Library filter fields","href":"/api-reference/library/discover-available-library-filter-fields"},{"openapi":"get /admin/workspace-library/files/{file}/source","title":"Get an unadmitted Drive original URL","href":"/api-reference/library/get-an-unadmitted-drive-original-url"},{"openapi":"post /admin/workspace-library/documents/{document}/links","title":"Link a canonical document to a record","href":"/api-reference/library/link-a-canonical-document-to-a-record"},{"openapi":"get /admin/workspace-library/documents/{document}/links","title":"List active document links","href":"/api-reference/library/list-active-document-links"},{"openapi":"get /admin/workspace-library/documents","title":"List canonical Library documents","href":"/api-reference/library/list-canonical-library-documents"},{"openapi":"get /admin/workspace-library/consent-evidence","title":"List consent evidence for a recipient","href":"/api-reference/library/list-consent-evidence-for-a-recipient"},{"openapi":"get /admin/workspace-library/drive/roots/{root}/analysis-issues","title":"List failed image analyses in a shared root","href":"/api-reference/library/list-failed-image-analyses-in-a-shared-root"},{"openapi":"get /admin/workspace-library/documents/{document}/versions","title":"List immutable source versions","href":"/api-reference/library/list-immutable-source-versions"},{"openapi":"get /admin/workspace-library/file-views","title":"List my saved Library filter views","href":"/api-reference/library/list-my-saved-library-filter-views"},{"openapi":"get /admin/workspace-library/file-record-folders","title":"List record folders containing uploads","href":"/api-reference/library/list-record-folders-containing-uploads"},{"openapi":"get /admin/workspace-library/documents/{document}/excerpts","title":"List saved source excerpts","href":"/api-reference/library/list-saved-source-excerpts"},{"openapi":"get /admin/workspace-library/drive/connections/{connection}/drives","title":"List shared Google Drives","href":"/api-reference/library/list-shared-google-drives"},{"openapi":"get /admin/workspace-library/files/{file}/stories","title":"List stories using a Library file","href":"/api-reference/library/list-stories-using-a-library-file"},{"openapi":"get /admin/workspace-library/files","title":"List the accessible Library file catalog","href":"/api-reference/library/list-the-accessible-library-file-catalog"},{"openapi":"post /admin/workspace-library/drive/roots/{root}/context","title":"Map a shared Drive folder to a program","href":"/api-reference/library/map-a-shared-drive-folder-to-a-program"},{"openapi":"get /admin/workspace-library/files/{file}/preview","title":"Preview or download catalog file bytes","href":"/api-reference/library/preview-or-download-catalog-file-bytes"},{"openapi":"post /admin/workspace-library/documents/{document}/capture-url","title":"Queue an HTTPS source capture","href":"/api-reference/library/queue-an-https-source-capture"},{"openapi":"post /admin/workspace-library/files/{file}/analysis","title":"Queue analysis for the current Library image","href":"/api-reference/library/queue-analysis-for-the-current-library-image"},{"openapi":"get /admin/workspace-library/files/{file}","title":"Read a catalog file metadata","href":"/api-reference/library/read-a-catalog-file-metadata"},{"openapi":"get /admin/workspace-library/documents/{document}","title":"Read canonical document metadata","href":"/api-reference/library/read-canonical-document-metadata"},{"openapi":"get /admin/workspace-library/files/{file}/analysis","title":"Read current file analysis status","href":"/api-reference/library/read-current-file-analysis-status"},{"openapi":"get /admin/workspace-library/documents/{document}/source-status","title":"Read current upload and URL-capture status","href":"/api-reference/library/read-current-upload-and-url-capture-status"},{"openapi":"get /admin/workspace-library/drive/roots/{root}/context","title":"Read Drive folder program mappings","href":"/api-reference/library/read-drive-folder-program-mappings"},{"openapi":"get /admin/workspace-library/drive","title":"Read Drive source connections and sync progress","href":"/api-reference/library/read-drive-source-connections-and-sync-progress"},{"openapi":"get /admin/workspace-library/documents/{document}/projections/{projection}","title":"Read extracted document text and a citation range","href":"/api-reference/library/read-extracted-document-text-and-a-citation-range"},{"openapi":"get /admin/workspace-library/files/{file}/clearance","title":"Read file clearance and consent decisions","href":"/api-reference/library/read-file-clearance-and-consent-decisions"},{"openapi":"get /admin/workspace-library/documents/{document}/versions/{version}/preview","title":"Read immutable document source bytes","href":"/api-reference/library/read-immutable-document-source-bytes"},{"openapi":"get /admin/workspace-library/file-organization","title":"Read Library organization and storage summary","href":"/api-reference/library/read-library-organization-and-storage-summary"},{"openapi":"post /admin/workspace-library/consent-evidence","title":"Record recipient media consent evidence","href":"/api-reference/library/record-recipient-media-consent-evidence"},{"openapi":"patch /admin/workspace-library/files/{file}/stories/{story}","title":"Redirect edits of existing Library stories","href":"/api-reference/library/redirect-edits-of-existing-library-stories"},{"openapi":"delete /admin/workspace-library/documents/{document}/excerpts/{excerpt}","title":"Remove a saved source excerpt","href":"/api-reference/library/remove-a-saved-source-excerpt"},{"openapi":"delete /admin/workspace-library/files/{file}/analysis","title":"Remove analysis for the confirmed image bytes","href":"/api-reference/library/remove-analysis-for-the-confirmed-image-bytes"},{"openapi":"patch /admin/workspace-library/documents/{document}","title":"Rename a canonical Library document","href":"/api-reference/library/rename-a-canonical-library-document"},{"openapi":"patch /admin/workspace-library/file-collections/{collection}","title":"Rename a personal Library collection","href":"/api-reference/library/rename-a-personal-library-collection"},{"openapi":"patch /admin/workspace-library/file-views/{viewId}","title":"Replace a personal Library filter view","href":"/api-reference/library/replace-a-personal-library-filter-view"},{"openapi":"post /admin/workspace-library/consent-evidence/{evidenceId}/revoke","title":"Revoke recipient consent evidence","href":"/api-reference/library/revoke-recipient-consent-evidence"},{"openapi":"post /admin/workspace-library/file-views","title":"Save a personal Library filter view","href":"/api-reference/library/save-a-personal-library-filter-view"},{"openapi":"post /admin/workspace-library/documents/{document}/excerpts","title":"Save a verified source excerpt","href":"/api-reference/library/save-a-verified-source-excerpt"},{"openapi":"post /admin/workspace-library/drive/roots/{root}/retry","title":"Schedule a shared Drive source retry","href":"/api-reference/library/schedule-a-shared-drive-source-retry"},{"openapi":"get /admin/workspace-library/documents/{document}/link-records","title":"Search accessible records to link a document","href":"/api-reference/library/search-accessible-records-to-link-a-document"},{"openapi":"get /admin/workspace-library/file-filter-records","title":"Search or hydrate linked-record filter options","href":"/api-reference/library/search-or-hydrate-linked-record-filter-options"},{"openapi":"post /admin/workspace-library/drive/roots/{root}/analysis","title":"Set automatic image analysis for a shared root","href":"/api-reference/library/set-automatic-image-analysis-for-a-shared-root"},{"openapi":"post /admin/workspace-library/drive/connections/{connection}/roots","title":"Share a Drive folder with the organization","href":"/api-reference/library/share-a-drive-folder-with-the-organization"},{"openapi":"patch /admin/workspace-library/file-preferences","title":"Star files or assign a personal collection","href":"/api-reference/library/star-files-or-assign-a-personal-collection"},{"openapi":"post /admin/workspace-library/drive/connect","title":"Start a Google Drive connection","href":"/api-reference/library/start-a-google-drive-connection"},{"openapi":"post /admin/workspace-library/drive/roots/{root}/stop","title":"Stop sharing a Drive folder","href":"/api-reference/library/stop-sharing-a-drive-folder"},{"openapi":"delete /admin/workspace-library/documents/{document}/links/{link}","title":"Unlink a canonical document from a record","href":"/api-reference/library/unlink-a-canonical-document-from-a-record"},{"openapi":"put /admin/workspace-library/files/{file}/clearance","title":"Update file clearance or safety signals","href":"/api-reference/library/update-file-clearance-or-safety-signals"},{"openapi":"put /admin/workspace-library/upload-admissions/{admission}/bytes","title":"Upload the authorized source bytes","href":"/api-reference/library/upload-the-authorized-source-bytes"}]},{"group":"Notifications","pages":[{"openapi":"get /admin/notification-preferences","title":"Get my notification preferences","href":"/api-reference/notifications/get-my-notification-preferences"},{"openapi":"get /notification/count","title":"Get the legacy notification count","href":"/api-reference/notifications/get-the-legacy-notification-count"},{"openapi":"get /notification/list","title":"List legacy notifications","href":"/api-reference/notifications/list-legacy-notifications"},{"openapi":"put /admin/notification-preferences","title":"Update my notification preferences","href":"/api-reference/notifications/update-my-notification-preferences"}]},{"group":"Participation","pages":[{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/recipients","title":"Add a new recipient during participation intake","href":"/api-reference/participation/add-a-new-recipient-during-participation-intake"},{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/existing-recipients","title":"Add an existing recipient to a draft check","href":"/api-reference/participation/add-an-existing-recipient-to-a-draft-check"},{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/new-entrants","title":"Add newly available recipients to a draft check","href":"/api-reference/participation/add-newly-available-recipients-to-a-draft-check"},{"openapi":"post /admin/programs/{program_id}/participation/imports/{participation_import_id}/commit","title":"Commit a reviewed attendance import","href":"/api-reference/participation/commit-a-reviewed-attendance-import"},{"openapi":"put /admin/programs/{program_id}/participation/setup","title":"Configure program participation","href":"/api-reference/participation/configure-program-participation"},{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/corrections","title":"Create a correction draft for a submitted check","href":"/api-reference/participation/create-a-correction-draft-for-a-submitted-check"},{"openapi":"post /admin/programs/{program_id}/participation/recipients/{entity_id}/follow-up","title":"Create or reuse a recipient participation follow-up","href":"/api-reference/participation/create-or-reuse-a-recipient-participation-follow-up"},{"openapi":"get /admin/programs/{program_id}/participation/sessions/{session_id}/recipient-suggestions","title":"Find possible existing recipients for check intake","href":"/api-reference/participation/find-possible-existing-recipients-for-check-intake"},{"openapi":"get /admin/programs/{program_id}/participation/imports/{participation_import_id}","title":"Get attendance import review and progress","href":"/api-reference/participation/get-attendance-import-review-and-progress"},{"openapi":"get /admin/programs/{program_id}/participation/exceptions","title":"List participation and profile exceptions","href":"/api-reference/participation/list-participation-and-profile-exceptions"},{"openapi":"get /admin/programs/{program_id}/participation/sessions","title":"List participation check history","href":"/api-reference/participation/list-participation-check-history"},{"openapi":"get /admin/programs/{program_id}/participation/imports","title":"List recent participation imports","href":"/api-reference/participation/list-recent-participation-imports"},{"openapi":"get /admin/programs/{program_id}/participation/placement-bootstrap","title":"Preview placement reconciliation","href":"/api-reference/participation/preview-placement-reconciliation"},{"openapi":"post /admin/programs/{program_id}/participation/imports/{participation_import_id}/validate","title":"Queue attendance import validation","href":"/api-reference/participation/queue-attendance-import-validation"},{"openapi":"get /admin/programs/{program_id}/participation/sessions/{session_id}","title":"Read a participation check and roster","href":"/api-reference/participation/read-a-participation-check-and-roster"},{"openapi":"get /admin/programs/{program_id}/participation/recipients/{entity_id}","title":"Read a recipient participation timeline","href":"/api-reference/participation/read-a-recipient-participation-timeline"},{"openapi":"get /admin/programs/{program_id}/participation","title":"Read program participation overview","href":"/api-reference/participation/read-program-participation-overview"},{"openapi":"post /admin/programs/{program_id}/participation/placement-bootstrap","title":"Reconcile legacy recipient placements","href":"/api-reference/participation/reconcile-legacy-recipient-placements"},{"openapi":"patch /admin/programs/{program_id}/participation/imports/{participation_import_id}/rows/{participation_import_row_id}","title":"Resolve an imported attendance recipient","href":"/api-reference/participation/resolve-an-imported-attendance-recipient"},{"openapi":"post /admin/programs/{program_id}/participation/sessions","title":"Start or reuse a participation check","href":"/api-reference/participation/start-or-reuse-a-participation-check"},{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/submit","title":"Submit a participation check","href":"/api-reference/participation/submit-a-participation-check"},{"openapi":"patch /admin/programs/{program_id}/participation/sessions/{session_id}/observations","title":"Update draft roster observations together","href":"/api-reference/participation/update-draft-roster-observations-together"},{"openapi":"patch /admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id}","title":"Update one draft roster observation","href":"/api-reference/participation/update-one-draft-roster-observation"},{"openapi":"post /admin/programs/{program_id}/participation/imports","title":"Upload an attendance workbook","href":"/api-reference/participation/upload-an-attendance-workbook"},{"openapi":"post /admin/programs/{program_id}/participation/imports/{participation_import_id}/void","title":"Void a completed attendance import","href":"/api-reference/participation/void-a-completed-attendance-import"},{"openapi":"post /admin/programs/{program_id}/participation/sessions/{session_id}/void","title":"Void a draft or submitted participation check","href":"/api-reference/participation/void-a-draft-or-submitted-participation-check"}]},{"group":"Payment Gateways","pages":[{"openapi":"post /integrations/stripe/webhook-status","title":"Check Stripe webhook configuration","href":"/api-reference/payment-gateways/check-stripe-webhook-configuration"},{"openapi":"get /connect/{token}","title":"Complete new Stripe account setup","href":"/api-reference/payment-gateways/complete-new-stripe-account-setup"},{"openapi":"post /integrations/stripe/webhook-events","title":"Enable supported Stripe webhook events","href":"/api-reference/payment-gateways/enable-supported-stripe-webhook-events"},{"openapi":"post /payment-gateways/{name}","title":"Update direct payment gateway credentials","href":"/api-reference/payment-gateways/update-direct-payment-gateway-credentials"}]},{"group":"Payments","pages":[{"openapi":"post /stripe-connect/existing-account-onboarding","title":"Authorize an existing Stripe account without direct keys","href":"/api-reference/payments/authorize-an-existing-stripe-account-without-direct-keys"},{"openapi":"get /account_session","title":"Check the unavailable legacy account session","href":"/api-reference/payments/check-the-unavailable-legacy-account-session"},{"openapi":"put /frontend/flutterwave-v4/campaign-charge/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Continue a Flutterwave v4 campaign charge","href":"/api-reference/payments/continue-a-flutterwave-v4-campaign-charge"},{"openapi":"put /frontend/flutterwave-v4/order-charge/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Continue a Flutterwave v4 order charge","href":"/api-reference/payments/continue-a-flutterwave-v4-order-charge"},{"openapi":"post /frontend/flutterwave_payment_plan/{client_id}/{program_id}/{session_id}","title":"Create a legacy Flutterwave payment plan checkout","href":"/api-reference/payments/create-a-legacy-flutterwave-payment-plan-checkout"},{"openapi":"post /flutterwave/payment","title":"Create the legacy fixed Flutterwave setup charge","href":"/api-reference/payments/create-the-legacy-fixed-flutterwave-setup-charge"},{"openapi":"post /flutterwave/subaccount","title":"Create the organization Flutterwave subaccount","href":"/api-reference/payments/create-the-organization-flutterwave-subaccount"},{"openapi":"delete /flutterwave/subaccount","title":"Delete the organization Flutterwave subaccount","href":"/api-reference/payments/delete-the-organization-flutterwave-subaccount"},{"openapi":"delete /connect","title":"Disconnect a Stripe Connect integration","href":"/api-reference/payments/disconnect-a-stripe-connect-integration"},{"openapi":"get /stripe-connect/status","title":"Get connected Stripe readiness","href":"/api-reference/payments/get-connected-stripe-readiness"},{"openapi":"get /payment-gateways/settings","title":"Get payment gateway setup settings","href":"/api-reference/payments/get-payment-gateway-setup-settings"},{"openapi":"get /flutterwave/subaccount","title":"Get the organization Flutterwave subaccount","href":"/api-reference/payments/get-the-organization-flutterwave-subaccount"},{"openapi":"get /account/form","title":"Get the platform Stripe publishable key","href":"/api-reference/payments/get-the-platform-stripe-publishable-key"},{"openapi":"post /frontend/flutterwave-v4/campaign-charge/{client_id}/{program_id}/{session_id}","title":"Initialize a Flutterwave v4 campaign charge","href":"/api-reference/payments/initialize-a-flutterwave-v4-campaign-charge"},{"openapi":"post /frontend/flutterwave-v4/order-charge/{client_id}/{program_id}/{session_id}","title":"Initialize a Flutterwave v4 order charge","href":"/api-reference/payments/initialize-a-flutterwave-v4-order-charge"},{"openapi":"get /flutterwave/banks/{id}/branches","title":"List Flutterwave bank branches","href":"/api-reference/payments/list-flutterwave-bank-branches"},{"openapi":"get /flutterwave/banks/{country}","title":"List Flutterwave banks for a country","href":"/api-reference/payments/list-flutterwave-banks-for-a-country"},{"openapi":"get /flutterwave/countries","title":"List Flutterwave setup countries","href":"/api-reference/payments/list-flutterwave-setup-countries"},{"openapi":"post /stripe-connect/existing-account-link","title":"Refresh authentication for an existing direct Stripe account","href":"/api-reference/payments/refresh-authentication-for-an-existing-direct-stripe-account"},{"openapi":"post /stripe-connect/pending-onboarding/refresh","title":"Refresh pending Stripe account readiness","href":"/api-reference/payments/refresh-pending-stripe-account-readiness"},{"openapi":"get /stripe_connect_details","title":"Retired legacy signup payment setup","href":"/api-reference/payments/retired-legacy-signup-payment-setup"},{"openapi":"get /frontend/flutterwave-v4/campaign-charge/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Retrieve a Flutterwave v4 campaign charge","href":"/api-reference/payments/retrieve-a-flutterwave-v4-campaign-charge"},{"openapi":"get /frontend/flutterwave-v4/campaign-charge-reference/{client_id}/{program_id}/{reference}/{session_id}","title":"Retrieve a Flutterwave v4 campaign charge by checkout reference","href":"/api-reference/payments/retrieve-a-flutterwave-v4-campaign-charge-by-checkout-reference"},{"openapi":"get /frontend/flutterwave-v4/order-charge/{client_id}/{program_id}/{charge_id}/{session_id}","title":"Retrieve a Flutterwave v4 order charge","href":"/api-reference/payments/retrieve-a-flutterwave-v4-order-charge"},{"openapi":"get /frontend/flutterwave-v4/order-charge-reference/{client_id}/{program_id}/{reference}/{session_id}","title":"Retrieve a Flutterwave v4 order charge by checkout reference","href":"/api-reference/payments/retrieve-a-flutterwave-v4-order-charge-by-checkout-reference"},{"openapi":"post /stripe-connect/onboarding-link","title":"Start new Stripe account onboarding","href":"/api-reference/payments/start-new-stripe-account-onboarding"},{"openapi":"get /stripe/{id}","title":"Start Stripe onboarding through the legacy route","href":"/api-reference/payments/start-stripe-onboarding-through-the-legacy-route"},{"openapi":"post /flutterwave/validate","title":"Submit Flutterwave charge authorization","href":"/api-reference/payments/submit-flutterwave-charge-authorization"},{"openapi":"post /stripe-connect/existing-account-link/rollback","title":"Temporarily restore retained direct Stripe authentication","href":"/api-reference/payments/temporarily-restore-retained-direct-stripe-authentication"},{"openapi":"put /flutterwave/subaccount","title":"Update the organization Flutterwave subaccount","href":"/api-reference/payments/update-the-organization-flutterwave-subaccount"},{"openapi":"post /frontend/flutterwave/verify/{client_id}/{program_id}/{session_id}","title":"Verify a legacy Flutterwave transaction","href":"/api-reference/payments/verify-a-legacy-flutterwave-transaction"}]},{"group":"Programs","pages":[{"openapi":"post /admin/program/form/donor","title":"Add a donor form to a program","href":"/api-reference/programs/add-a-donor-form-to-a-program"},{"openapi":"post /admin/program/form/sponsorship","title":"Add a sponsorship form to a program","href":"/api-reference/programs/add-a-sponsorship-form-to-a-program"},{"openapi":"post /admin/program/emailset","title":"Attach an email set to a program","href":"/api-reference/programs/attach-an-email-set-to-a-program"},{"openapi":"post /admin/program/smsset","title":"Attach an SMS template set to a program","href":"/api-reference/programs/attach-an-sms-template-set-to-a-program"},{"openapi":"post /admin/program/settings","title":"Attach settings to a program","href":"/api-reference/programs/attach-settings-to-a-program"},{"openapi":"get /admin/edit_program/{program_id}","title":"Bootstrap data for the program edit form","href":"/api-reference/programs/bootstrap-data-for-the-program-edit-form"},{"openapi":"get /admin/add_sub_program","title":"Bootstrap data for the sub-program creation form","href":"/api-reference/programs/bootstrap-data-for-the-sub-program-creation-form"},{"openapi":"post /admin/multi_program_select","title":"Build the multi-program donor-frontend URL","href":"/api-reference/programs/build-the-multi-program-donor-frontend-url"},{"openapi":"post /admin/program","title":"Create a child program","href":"/api-reference/programs/create-a-child-program"},{"openapi":"post /admin/program/sub_program","title":"Create a sub program","href":"/api-reference/programs/create-a-sub-program"},{"openapi":"delete /admin/program/{program_id}/setup-draft","title":"Discard an empty program setup draft","href":"/api-reference/programs/discard-an-empty-program-setup-draft"},{"openapi":"put /admin/program/{program_id}","title":"Edit a program","href":"/api-reference/programs/edit-a-program"},{"openapi":"get /program/{id}/campaign","deprecated":true,"title":"Get campaign program details","href":"/api-reference/programs/get-campaign-program-details"},{"openapi":"get /program/{id}","title":"Get details of a specific program","href":"/api-reference/programs/get-details-of-a-specific-program"},{"openapi":"get /frontend/program/{client_id}/{program_id}/campaign","title":"Get organization-scoped campaign checkout metadata","href":"/api-reference/programs/get-organization-scoped-campaign-checkout-metadata"},{"openapi":"get /program/{id}/settings","title":"Get program settings","href":"/api-reference/programs/get-program-settings"},{"openapi":"get /admin/program/{program_id}/setup-state","title":"Get program setup readiness","href":"/api-reference/programs/get-program-setup-readiness"},{"openapi":"get /admin/program/{program_id}/launch-context","title":"Get program website launch context","href":"/api-reference/programs/get-program-website-launch-context"},{"openapi":"get /admin/program/setup-options","title":"List compatible program setup modules","href":"/api-reference/programs/list-compatible-program-setup-modules"},{"openapi":"get /programs","title":"Manage programs","href":"/api-reference/programs/manage-programs"},{"openapi":"post /admin/updatetree","title":"Persist a reordered/reparented programs tree","href":"/api-reference/programs/persist-a-reorderedreparented-programs-tree"},{"openapi":"get /admin/multi_program_select","title":"Programs sharing a donor form that allow combined checkout","href":"/api-reference/programs/programs-sharing-a-donor-form-that-allow-combined-checkout"},{"openapi":"delete /admin/program/{program_id}","title":"Remove a program","href":"/api-reference/programs/remove-a-program"},{"openapi":"patch /admin/program/{program_id}/name","title":"Rename a program","href":"/api-reference/programs/rename-a-program"},{"openapi":"get /admin/program/{program_id}/additional-gift-targets","title":"Search program gift-routing recipients","href":"/api-reference/programs/search-program-gift-routing-recipients"},{"openapi":"patch /admin/program/{program_id}/identity","title":"Update a program name and abbreviation","href":"/api-reference/programs/update-a-program-name-and-abbreviation"},{"openapi":"patch /admin/program/{program_id}/additional-gift-routes","title":"Update program additional-gift routes","href":"/api-reference/programs/update-program-additional-gift-routes"},{"openapi":"patch /admin/program/{program_id}/launch-settings","title":"Update program website settings","href":"/api-reference/programs/update-program-website-settings"}]},{"group":"Public","pages":[{"openapi":"post /frontend/checkout_add_designation_only/{client_id}/{hysform_id}/{designation_id}/{currency}/{session_id}","title":"Add a designation-only gift to checkout","href":"/api-reference/public/add-a-designation-only-gift-to-checkout"},{"openapi":"post /frontend/entity/save/{client_id}/{program_id}/{entity_id}","title":"Add a recipient to the public checkout cart","href":"/api-reference/public/add-a-recipient-to-the-public-checkout-cart"},{"openapi":"post /frontend/entity/save/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Add a recipient to the public checkout cart","href":"/api-reference/public/add-a-recipient-to-the-public-checkout-cart-1"},{"openapi":"post /frontend/checkout/offer/{client_id}/{program_id}/{session_id}","title":"Add the configured optional sponsorship to a checkout","href":"/api-reference/public/add-the-configured-optional-sponsorship-to-a-checkout"},{"openapi":"post /frontend/checkout/ideal/{client_id}/{program_id}/{token}/cancel","title":"Cancel an iDEAL | Wero checkout","href":"/api-reference/public/cancel-an-ideal---wero-checkout"},{"openapi":"put /frontend/checkout/frequency/{client_id}/{program_id}/{entity_id}/{frequency}","title":"Change a saved recipient payment frequency","href":"/api-reference/public/change-a-saved-recipient-payment-frequency"},{"openapi":"put /frontend/checkout/frequency/{client_id}/{program_id}/{entity_id}/{frequency}/{session_id}","title":"Change a saved recipient payment frequency","href":"/api-reference/public/change-a-saved-recipient-payment-frequency-1"},{"openapi":"put /frontend/checkout/amount/{client_id}/{program_id}/{entity_id}/{amount}/{currency}","title":"Change a saved recipient sponsorship amount","href":"/api-reference/public/change-a-saved-recipient-sponsorship-amount"},{"openapi":"put /frontend/checkout/amount/{client_id}/{program_id}/{entity_id}/{amount}/{currency}/{session_id}","title":"Change a saved recipient sponsorship amount","href":"/api-reference/public/change-a-saved-recipient-sponsorship-amount-1"},{"openapi":"post /frontend/logged_in_checkout/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Complete checkout for an already logged-in donor","href":"/api-reference/public/complete-checkout-for-an-already-logged-in-donor"},{"openapi":"post /frontend/checkout_login_only/{client_id}/{hysform_id}/{designation_id}/{session_id}","title":"Complete designation-only checkout for an existing donor","href":"/api-reference/public/complete-designation-only-checkout-for-an-existing-donor"},{"openapi":"post /frontend/checkout/ideal/{client_id}/{program_id}/{token}/complete","title":"Confirm an iDEAL | Wero checkout","href":"/api-reference/public/confirm-an-ideal---wero-checkout"},{"openapi":"post /frontend/checkout/campaign-offer/{client_id}/{program_id}","title":"Create a campaign cart before an optional sponsorship offer","href":"/api-reference/public/create-a-campaign-cart-before-an-optional-sponsorship-offer"},{"openapi":"post /frontend/checkout_signup_only/{client_id}/{hysform_id}/{designation_id}/{session_id}","title":"Create a donor and complete designation-only checkout","href":"/api-reference/public/create-a-donor-and-complete-designation-only-checkout"},{"openapi":"post /frontend/add_entity/{client_id}/{program_id}/{session_id}","title":"Create a public recipient/entity","href":"/api-reference/public/create-a-public-recipiententity"},{"openapi":"get /frontend/view_all/{client_id}/{program_id}/{session_id}","title":"Display titles and files with pagination","href":"/api-reference/public/display-titles-and-files-with-pagination"},{"openapi":"get /frontend/entities/view/{client_id}/{program_id}/{session_id}","title":"List entity names for a program","href":"/api-reference/public/list-entity-names-for-a-program"},{"openapi":"get /frontend/entities/pagination/{client_id}/{program_id}/{session_id}","title":"List paginated public frontend entities","href":"/api-reference/public/list-paginated-public-frontend-entities"},{"openapi":"get /frontend/entities/all/{client_id}/{program_id}/{session_id}","title":"List public frontend entities","href":"/api-reference/public/list-public-frontend-entities"},{"openapi":"get /frontend/view_pages/{client_id}/{program_id}/{session_id}","title":"List public recipients through the legacy page alias","href":"/api-reference/public/list-public-recipients-through-the-legacy-page-alias"},{"openapi":"get /frontend/public/trips/{clientSlugOrId}/{tripSlug}/participants","title":"List public trip participants","href":"/api-reference/public/list-public-trip-participants"},{"openapi":"post /frontend/checkout/email_lookup/{client_id}/{program_id}","title":"Look up checkout donors by email","href":"/api-reference/public/look-up-checkout-donors-by-email"},{"openapi":"post /frontend/checkout_email_lookup/{client_id}/{program_id}","title":"Look up checkout donors by email (legacy path)","href":"/api-reference/public/look-up-checkout-donors-by-email-legacy-path"},{"openapi":"post /frontend/checkout/campaign/{client_id}/{program_id}/{session_id}","title":"Process a campaign checkout","href":"/api-reference/public/process-a-campaign-checkout"},{"openapi":"post /frontend/checkout_remove_designation_only/{client_id}/{hysform_id}/{designation_id}/{id}/{currency}/{session_id}","title":"Remove a designation-only gift from checkout","href":"/api-reference/public/remove-a-designation-only-gift-from-checkout"},{"openapi":"delete /frontend/checkout/entity/{client_id}/{program_id}/{entity_id}","title":"Remove a recipient from the saved checkout","href":"/api-reference/public/remove-a-recipient-from-the-saved-checkout"},{"openapi":"delete /frontend/checkout/entity/{client_id}/{program_id}/{entity_id}/{session_id}","title":"Remove a recipient from the saved checkout","href":"/api-reference/public/remove-a-recipient-from-the-saved-checkout-1"},{"openapi":"delete /frontend/checkout/designation/{client_id}/{program_id}/{id}/{currency}","title":"Remove an extra designation gift from checkout","href":"/api-reference/public/remove-an-extra-designation-gift-from-checkout"},{"openapi":"delete /frontend/checkout/designation/{client_id}/{program_id}/{id}/{currency}/{session_id}","title":"Remove an extra designation gift from checkout","href":"/api-reference/public/remove-an-extra-designation-gift-from-checkout-1"},{"openapi":"post /frontend/public/trips/{clientSlugOrId}/{tripSlug}/request-to-join","title":"Request to join a public trip","href":"/api-reference/public/request-to-join-a-public-trip"},{"openapi":"get /frontend/save_entity","title":"Restore a saved entity to checkout","href":"/api-reference/public/restore-a-saved-entity-to-checkout"},{"openapi":"post /signup","deprecated":true,"title":"Retired legacy workspace signup","href":"/api-reference/public/retired-legacy-workspace-signup"},{"openapi":"get /frontend/add_entity/search/{client_id}/{program_id}/{session_id}","title":"Search public recipients before adding an entity","href":"/api-reference/public/search-public-recipients-before-adding-an-entity"},{"openapi":"get /frontend/orderD/{client_id}/{hysform_id}/{designation_id}/{session_id}","title":"Show a designation-only checkout page","href":"/api-reference/public/show-a-designation-only-checkout-page"},{"openapi":"get /frontend/public/peer-to-peer/{clientSlugOrId}/{programSlug}","title":"Show a public peer-to-peer program page","href":"/api-reference/public/show-a-public-peer-to-peer-program-page"},{"openapi":"get /frontend/public/peer-to-peer/{clientSlugOrId}/{programSlug}/recipients/{recipientSlug}","title":"Show a public peer-to-peer recipient profile","href":"/api-reference/public/show-a-public-peer-to-peer-recipient-profile"},{"openapi":"get /frontend/public/trips/{clientSlugOrId}/{tripSlug}","title":"Show a public trip page","href":"/api-reference/public/show-a-public-trip-page"},{"openapi":"get /frontend/public/trips/{clientSlugOrId}/{tripSlug}/participants/{participantSlug}","title":"Show a public trip participant profile","href":"/api-reference/public/show-a-public-trip-participant-profile"},{"openapi":"get /frontend/add_entity/{client_id}/{program_id}/{session_id}","title":"Show public add-recipient form configuration","href":"/api-reference/public/show-public-add-recipient-form-configuration"},{"openapi":"post /frontend/checkout/campaign-ideal/{client_id}/{program_id}","title":"Start bank redirect for a campaign donation","href":"/api-reference/public/start-bank-redirect-for-a-campaign-donation"},{"openapi":"post /frontend/checkout/campaign-ideal/{client_id}/{program_id}/{session_id}","title":"Start bank redirect for a campaign donation","href":"/api-reference/public/start-bank-redirect-for-a-campaign-donation-1"},{"openapi":"post /frontend/checkout/order-ideal/{client_id}/{program_id}/{session_id}","title":"Start bank redirect for an existing sponsorship order","href":"/api-reference/public/start-bank-redirect-for-an-existing-sponsorship-order"},{"openapi":"get /frontend/checkout_update_designation_frequency_only/{client_id}/{hysform_id}/{designation_id}/{id}/{frequency}/{session_id}","title":"Update a designation-only checkout frequency","href":"/api-reference/public/update-a-designation-only-checkout-frequency"}]},{"group":"Recipient Portal","pages":[{"openapi":"get /frontend/recipient-portal/logout/{client_id}/{session_id}","title":"End the recipient-portal session","href":"/api-reference/recipient-portal/end-the-recipient-portal-session"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/messages/{message_id}","title":"Get full message thread (root + replies)","href":"/api-reference/recipient-portal/get-full-message-thread-root-+-replies"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/donations","title":"Paginated list of donations to this recipient","href":"/api-reference/recipient-portal/paginated-list-of-donations-to-this-recipient"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/donors","title":"Paginated list of donors who support this recipient","href":"/api-reference/recipient-portal/paginated-list-of-donors-who-support-this-recipient"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/messages","title":"Paginated list of message threads + donor address book","href":"/api-reference/recipient-portal/paginated-list-of-message-threads-+-donor-address-book"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/profile","title":"Profile-edit form schema + current values","href":"/api-reference/recipient-portal/profile-edit-form-schema-+-current-values"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}","title":"Recipient-portal dashboard","href":"/api-reference/recipient-portal/recipient-portal-dashboard"},{"openapi":"get /frontend/recipient-portal/login/{client_id}/{program_id}/{session_id}","title":"Render the recipient-portal login page","href":"/api-reference/recipient-portal/render-the-recipient-portal-login-page"},{"openapi":"post /frontend/recipient-portal/{client_id}/{session_id}/messages/{message_id}/reply","title":"Reply to an existing message thread","href":"/api-reference/recipient-portal/reply-to-an-existing-message-thread"},{"openapi":"post /frontend/recipient-portal/login/{client_id}/{program_id}/{session_id}","title":"Request a recipient-portal verification code by email","href":"/api-reference/recipient-portal/request-a-recipient-portal-verification-code-by-email"},{"openapi":"get /frontend/recipient-portal/{client_id}/{session_id}/donor-options","title":"Search donors the recipient is allowed to message","href":"/api-reference/recipient-portal/search-donors-the-recipient-is-allowed-to-message"},{"openapi":"post /frontend/recipient-portal/{client_id}/{session_id}/messages","title":"Send a new message from the recipient to a donor","href":"/api-reference/recipient-portal/send-a-new-message-from-the-recipient-to-a-donor"},{"openapi":"post /frontend/recipient-portal/{client_id}/{session_id}/impact-stories","title":"Submit a recipient impact story for staff review","href":"/api-reference/recipient-portal/submit-a-recipient-impact-story-for-staff-review"},{"openapi":"put /frontend/recipient-portal/{client_id}/{session_id}/profile","title":"Update the recipient's profile fields","href":"/api-reference/recipient-portal/update-the-recipients-profile-fields"},{"openapi":"get /frontend/recipient-portal/verify_token/{client_id}/{token}","title":"Verify a recipient portal magic link","href":"/api-reference/recipient-portal/verify-a-recipient-portal-magic-link"},{"openapi":"post /frontend/recipient-portal/verify_code/{client_id}","title":"Verify the recipient-portal login code","href":"/api-reference/recipient-portal/verify-the-recipient-portal-login-code"}]},{"group":"Recipients","pages":[{"openapi":"post /admin/entities/{program_id}/footer-calculations","title":"Count recipient worksheet footer values","href":"/api-reference/recipients/count-recipient-worksheet-footer-values"},{"openapi":"post /admin/entities/filter/{program_id}","title":"Filter recipient worksheet rows","href":"/api-reference/recipients/filter-recipient-worksheet-rows"},{"openapi":"post /admin/program/entities/tags/replacement-preview","title":"Preview existing recipient tags before replacement","href":"/api-reference/recipients/preview-existing-recipient-tags-before-replacement"},{"openapi":"post /admin/entities/{program_id}/export","title":"Queue a recipient worksheet CSV export","href":"/api-reference/recipients/queue-a-recipient-worksheet-csv-export"},{"openapi":"get /admin/entities/{program_id}/column-preferences","title":"Read recipient worksheet column preferences","href":"/api-reference/recipients/read-recipient-worksheet-column-preferences"}]},{"group":"Reports","pages":[{"openapi":"get /admin/program/{program_id}/progress","title":"Aggregate progress / KPI roll-up for a program","href":"/api-reference/reports/aggregate-progress-kpi-roll-up-for-a-program"},{"openapi":"get /admin/dashboard/tiles/values","title":"Calculate pinned report tile values","href":"/api-reference/reports/calculate-pinned-report-tile-values"},{"openapi":"post /admin/reports/{id}/worksheet-summary","title":"Calculate report worksheet totals","href":"/api-reference/reports/calculate-report-worksheet-totals"},{"openapi":"get /admin/reports/source-counts","title":"Count reports by source","href":"/api-reference/reports/count-reports-by-source"},{"openapi":"post /admin/reports/{id}/audience","title":"Create a report audience handoff","href":"/api-reference/reports/create-a-report-audience-handoff"},{"openapi":"delete /admin/reports/{id}","title":"Delete a saved report","href":"/api-reference/reports/delete-a-saved-report"},{"openapi":"get /admin/reports/exports/{uploadId}","title":"Download a completed report CSV","href":"/api-reference/reports/download-a-completed-report-csv"},{"openapi":"post /admin/reports/{id}/duplicate","title":"Duplicate a report","href":"/api-reference/reports/duplicate-a-report"},{"openapi":"get /admin/reports/{id}","title":"Get a saved report","href":"/api-reference/reports/get-a-saved-report"},{"openapi":"get /admin/reports/meta","title":"Get report-builder metadata","href":"/api-reference/reports/get-report-builder-metadata"},{"openapi":"get /admin/reports/fields","title":"Get report source fields","href":"/api-reference/reports/get-report-source-fields"},{"openapi":"get /admin/reports/{id}/details","title":"Get saved report insights","href":"/api-reference/reports/get-saved-report-insights"},{"openapi":"get /admin/reports/counts","title":"Get visible report row counts","href":"/api-reference/reports/get-visible-report-row-counts"},{"openapi":"get /admin/worksheet/fields","title":"Get worksheet field metadata","href":"/api-reference/reports/get-worksheet-field-metadata"},{"openapi":"get /admin/reports/templates","title":"List available report templates","href":"/api-reference/reports/list-available-report-templates"},{"openapi":"get /admin/dashboard/tiles","title":"List pinned report dashboard tiles","href":"/api-reference/reports/list-pinned-report-dashboard-tiles"},{"openapi":"get /admin/reports","title":"List saved reports","href":"/api-reference/reports/list-saved-reports"},{"openapi":"get /admin/reports/catalog","title":"List the saved report catalog","href":"/api-reference/reports/list-the-saved-report-catalog"},{"openapi":"get /admin/dashboard/home/sections/{section}","title":"Load a dashboard home section","href":"/api-reference/reports/load-a-dashboard-home-section"},{"openapi":"get /admin/dashboard/home","title":"Load dashboard home","href":"/api-reference/reports/load-dashboard-home"},{"openapi":"post /admin/dashboard/tiles","title":"Pin a report dashboard tile","href":"/api-reference/reports/pin-a-report-dashboard-tile"},{"openapi":"get /admin/reports/exports/{uploadId}/status","title":"Poll a report CSV export","href":"/api-reference/reports/poll-a-report-csv-export"},{"openapi":"post /admin/dashboard/tiles/preview","title":"Preview a report dashboard metric","href":"/api-reference/reports/preview-a-report-dashboard-metric"},{"openapi":"get /admin/reports/{id}/preview","title":"Preview a saved report","href":"/api-reference/reports/preview-a-saved-report"},{"openapi":"post /admin/reports/preview","title":"Preview an unsaved report definition","href":"/api-reference/reports/preview-an-unsaved-report-definition"},{"openapi":"post /admin/reports/{id}/run","title":"Queue a report run","href":"/api-reference/reports/queue-a-report-run"},{"openapi":"post /admin/reports/{id}/export","title":"Queue an export of report rows","href":"/api-reference/reports/queue-an-export-of-report-rows"},{"openapi":"get /admin/reports/{id}/rows/{recordId}/related","title":"Read related records for a report row","href":"/api-reference/reports/read-related-records-for-a-report-row"},{"openapi":"get /admin/reports/{id}/rows","title":"Read report worksheet rows","href":"/api-reference/reports/read-report-worksheet-rows"},{"openapi":"delete /admin/dashboard/tiles/{id}","title":"Remove a pinned report tile","href":"/api-reference/reports/remove-a-pinned-report-tile"},{"openapi":"delete /admin/reports/{id}/schedule","title":"Remove a report schedule","href":"/api-reference/reports/remove-a-report-schedule"},{"openapi":"get /admin/reports/audience/{token}","title":"Resolve a report audience token","href":"/api-reference/reports/resolve-a-report-audience-token"},{"openapi":"post /admin/reports","title":"Save a report definition","href":"/api-reference/reports/save-a-report-definition"},{"openapi":"post /admin/reports/{id}/schedule","title":"Schedule a report","href":"/api-reference/reports/schedule-a-report"},{"openapi":"put /admin/dashboard/mode","title":"Set the organization dashboard mode","href":"/api-reference/reports/set-the-organization-dashboard-mode"},{"openapi":"patch /admin/reports/{id}/star","title":"Star or unstar a saved report","href":"/api-reference/reports/star-or-unstar-a-saved-report"},{"openapi":"post /admin/reports/{id}/tag","title":"Tag records selected from a report","href":"/api-reference/reports/tag-records-selected-from-a-report"},{"openapi":"patch /admin/dashboard/tiles/{id}","title":"Update a pinned report tile","href":"/api-reference/reports/update-a-pinned-report-tile"},{"openapi":"put /admin/reports/{id}","title":"Update a report definition","href":"/api-reference/reports/update-a-report-definition"},{"openapi":"patch /admin/reports/{id}","title":"Update a report definition","href":"/api-reference/reports/update-a-report-definition-1"},{"openapi":"put /admin/dashboard/preferences","title":"Update report dashboard preferences","href":"/api-reference/reports/update-report-dashboard-preferences"}]},{"group":"Schema","pages":[{"openapi":"get /schema/models/{name}","title":"Get an exposed model schema","href":"/api-reference/schema/get-an-exposed-model-schema"},{"openapi":"get /schema/capabilities","title":"Get automation API capabilities","href":"/api-reference/schema/get-automation-api-capabilities"},{"openapi":"get /schema/enums","title":"List API enums and constants","href":"/api-reference/schema/list-api-enums-and-constants"},{"openapi":"get /schema/models","title":"List exposed data models","href":"/api-reference/schema/list-exposed-data-models"}]},{"group":"Settings","pages":[{"openapi":"get /admin/settings/{settings_id}/payment-reminder-preflight","title":"Check grouped payment reminder readiness","href":"/api-reference/settings/check-grouped-payment-reminder-readiness"},{"openapi":"post /admin/settings/{settings_id}/clone","title":"Clone a program setting","href":"/api-reference/settings/clone-a-program-setting"},{"openapi":"get /geo/address-format/{country_code}","title":"Get address field labels","href":"/api-reference/settings/get-address-field-labels"},{"openapi":"get /admin/jurisdiction-profile","title":"Get organization jurisdiction settings","href":"/api-reference/settings/get-organization-jurisdiction-settings"},{"openapi":"get /admin/public-branding","title":"Get organization public branding","href":"/api-reference/settings/get-organization-public-branding"},{"openapi":"get /admin/privacy/record-disclosure","title":"Get restricted record display settings","href":"/api-reference/settings/get-restricted-record-display-settings"},{"openapi":"get /geo/countries","title":"List address countries","href":"/api-reference/settings/list-address-countries"},{"openapi":"get /geo/subdivisions/{country_code}","title":"List country subdivisions","href":"/api-reference/settings/list-country-subdivisions"},{"openapi":"patch /admin/navigation-preferences/pins","title":"Pin or unpin a navigation item","href":"/api-reference/settings/pin-or-unpin-a-navigation-item"},{"openapi":"patch /admin/navigation-preferences/expanded-groups","title":"Remember an expanded navigation group","href":"/api-reference/settings/remember-an-expanded-navigation-group"},{"openapi":"delete /admin/public-branding/program-color-overrides","title":"Reset program accent overrides","href":"/api-reference/settings/reset-program-accent-overrides"},{"openapi":"put /admin/programs/{program_id}/record-disclosure","title":"Update a program privacy override","href":"/api-reference/settings/update-a-program-privacy-override"},{"openapi":"put /admin/jurisdiction-profile","title":"Update organization jurisdiction settings","href":"/api-reference/settings/update-organization-jurisdiction-settings"},{"openapi":"patch /admin/public-branding","title":"Update organization public branding","href":"/api-reference/settings/update-organization-public-branding"},{"openapi":"put /admin/privacy/record-disclosure","title":"Update restricted record display levels","href":"/api-reference/settings/update-restricted-record-display-levels"}]},{"group":"Spaces","pages":[{"openapi":"post /admin/pages/{page}/archive","title":"Archive a page and its active descendants","href":"/api-reference/spaces/archive-a-page-and-its-active-descendants"},{"openapi":"post /admin/spaces/{type}/{id}/clearance","title":"Change clearance for files in a space","href":"/api-reference/spaces/change-clearance-for-files-in-a-space"},{"openapi":"post /admin/pages","title":"Create a page","href":"/api-reference/spaces/create-a-page"},{"openapi":"get /admin/spaces/recipient/{id}/supporters","title":"List a recipient space supporters","href":"/api-reference/spaces/list-a-recipient-space-supporters"},{"openapi":"get /admin/spaces/{type}/{id}/media","title":"List a space media page","href":"/api-reference/spaces/list-a-space-media-page"},{"openapi":"get /admin/spaces","title":"List accessible program spaces","href":"/api-reference/spaces/list-accessible-program-spaces"},{"openapi":"get /admin/spaces/{type}/{id}/sources","title":"List Drive sources mapped into a space","href":"/api-reference/spaces/list-drive-sources-mapped-into-a-space"},{"openapi":"get /admin/notifications/page-mentions","title":"List my page mention notifications","href":"/api-reference/spaces/list-my-page-mention-notifications"},{"openapi":"get /admin/pages/pinned","title":"List my pinned pages","href":"/api-reference/spaces/list-my-pinned-pages"},{"openapi":"get /admin/mentions/recent","title":"List recent mention suggestions","href":"/api-reference/spaces/list-recent-mention-suggestions"},{"openapi":"get /admin/pages/recent","title":"List recently edited pages","href":"/api-reference/spaces/list-recently-edited-pages"},{"openapi":"get /admin/page-documents/{document}/versions","title":"List saved page-document versions","href":"/api-reference/spaces/list-saved-page-document-versions"},{"openapi":"get /admin/spaces/{type}/{id}/stories","title":"List stories in a space","href":"/api-reference/spaces/list-stories-in-a-space"},{"openapi":"get /admin/spaces/needs-you","title":"List work needing attention across spaces","href":"/api-reference/spaces/list-work-needing-attention-across-spaces"},{"openapi":"post /admin/notifications/page-mentions/{notification}/read","title":"Mark a page mention notification read","href":"/api-reference/spaces/mark-a-page-mention-notification-read"},{"openapi":"post /admin/pages/{page}/move","title":"Move or reorder a page","href":"/api-reference/spaces/move-or-reorder-a-page"},{"openapi":"post /admin/pages/{page}/pin","title":"Pin a page for my user","href":"/api-reference/spaces/pin-a-page-for-my-user"},{"openapi":"get /admin/mentions/summary","title":"Read a mention summary card","href":"/api-reference/spaces/read-a-mention-summary-card"},{"openapi":"get /admin/page-documents/{document}","title":"Read a revisioned page document","href":"/api-reference/spaces/read-a-revisioned-page-document"},{"openapi":"get /admin/spaces/{type}/{id}","title":"Read a space header","href":"/api-reference/spaces/read-a-space-header"},{"openapi":"get /admin/spaces/{type}/{id}/overview","title":"Read a space overview","href":"/api-reference/spaces/read-a-space-overview"},{"openapi":"get /admin/pages/{page}","title":"Read page metadata and breadcrumbs","href":"/api-reference/spaces/read-page-metadata-and-breadcrumbs"},{"openapi":"get /admin/spaces/{type}/{id}/clearance-board","title":"Read the space clearance board","href":"/api-reference/spaces/read-the-space-clearance-board"},{"openapi":"get /admin/spaces/{subjectType}/{subjectId}/pages/tree","title":"Read the subject space page tree","href":"/api-reference/spaces/read-the-subject-space-page-tree"},{"openapi":"get /admin/pages/tree","title":"Read the workspace page tree","href":"/api-reference/spaces/read-the-workspace-page-tree"},{"openapi":"post /admin/mentions/request-access","title":"Request access to a mentioned record","href":"/api-reference/spaces/request-access-to-a-mentioned-record"},{"openapi":"post /admin/mentions/resolve","title":"Resolve labels for document mentions","href":"/api-reference/spaces/resolve-labels-for-document-mentions"},{"openapi":"post /admin/page-documents/{document}/versions/{version}/restore","title":"Restore a page-document version","href":"/api-reference/spaces/restore-a-page-document-version"},{"openapi":"post /admin/pages/{page}/restore","title":"Restore a page from trash","href":"/api-reference/spaces/restore-a-page-from-trash"},{"openapi":"patch /admin/page-documents/{document}","title":"Save a revisioned page document","href":"/api-reference/spaces/save-a-revisioned-page-document"},{"openapi":"get /admin/mentions/search","title":"Search accessible mention choices","href":"/api-reference/spaces/search-accessible-mention-choices"},{"openapi":"get /admin/pages/search","title":"Search page titles and document text","href":"/api-reference/spaces/search-page-titles-and-document-text"},{"openapi":"get /admin/spaces/search","title":"Search programs and recipients for a space","href":"/api-reference/spaces/search-programs-and-recipients-for-a-space"},{"openapi":"post /admin/spaces/{type}/{id}/clearance/undo","title":"Undo a space clearance change","href":"/api-reference/spaces/undo-a-space-clearance-change"},{"openapi":"delete /admin/pages/{page}/pin","title":"Unpin a page for my user","href":"/api-reference/spaces/unpin-a-page-for-my-user"},{"openapi":"patch /admin/pages/{page}","title":"Update page metadata","href":"/api-reference/spaces/update-page-metadata"}]},{"group":"Commitments","pages":[{"openapi":"post /admin/sponsorships","title":"Add a new commitment","href":"/api-reference/sponsorships/add-a-new-commitment"},{"openapi":"post /admin/donations/{donation_id}/funding","title":"Apply a received gift to recipient coverage","href":"/api-reference/sponsorships/apply-a-received-gift-to-recipient-coverage"},{"openapi":"post /admin/lifecycle-reason-sets/apply-template","title":"Apply starter lifecycle reasons","href":"/api-reference/sponsorships/apply-starter-lifecycle-reasons"},{"openapi":"post /admin/sponsorship-change-requests/{request_id}/approve","title":"Approve a donor sponsorship change request","href":"/api-reference/sponsorships/approve-a-donor-sponsorship-change-request"},{"openapi":"post /admin/sponsorships/{donor_entity_id}/archive","title":"Archive a commitment for a donor","href":"/api-reference/sponsorships/archive-a-commitment-for-a-donor"},{"openapi":"post /admin/sponsorships/archive","title":"Archive Sponsorships for Donors","href":"/api-reference/sponsorships/archive-sponsorships-for-donors"},{"openapi":"post /frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/confirm","title":"Confirm a donor sponsorship review","href":"/api-reference/sponsorships/confirm-a-donor-sponsorship-review"},{"openapi":"post /admin/sponsorships/{program_id}/footer-calculations","title":"Count sponsorship worksheet footer values","href":"/api-reference/sponsorships/count-sponsorship-worksheet-footer-values"},{"openapi":"post /admin/lifecycle-reason-sets/{reason_set_id}/reasons","title":"Create a lifecycle reason","href":"/api-reference/sponsorships/create-a-lifecycle-reason"},{"openapi":"get /admin/sponsorships/new","title":"Donors and Available Entities","href":"/api-reference/sponsorships/donors-and-available-entities"},{"openapi":"get /admin/sponsorships/exports/{uploadId}","title":"Download a finished commitment export","href":"/api-reference/sponsorships/download-a-finished-commitment-export"},{"openapi":"post /admin/sponsorships/program/filter/{program_id}","title":"Filter sponsorship worksheet rows","href":"/api-reference/sponsorships/filter-sponsorship-worksheet-rows"},{"openapi":"get /admin/list_available_entities","title":"Flat list of entities available for commitment picking","href":"/api-reference/sponsorships/flat-list-of-entities-available-for-commitment-picking"},{"openapi":"get /admin/sponsorship-change-requests/{request_id}","title":"Get a donor sponsorship approval request","href":"/api-reference/sponsorships/get-a-donor-sponsorship-approval-request"},{"openapi":"get /admin/sponsorships/statistics","title":"Get Commitment Statistics","href":"/api-reference/sponsorships/get-commitment-statistics"},{"openapi":"get /admin/donor/{id}/sponsorships","title":"Get commitments for a specific donor","href":"/api-reference/sponsorships/get-commitments-for-a-specific-donor"},{"openapi":"post /admin/sponsorships/{program_id}/headers","title":"Get Commitments Table Headers","href":"/api-reference/sponsorships/get-commitments-table-headers"},{"openapi":"get /frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}","title":"Get donor sponsorship management options","href":"/api-reference/sponsorships/get-donor-sponsorship-management-options"},{"openapi":"get /admin/sponsorships/lifecycle/options","title":"Get sponsorship lifecycle reasons","href":"/api-reference/sponsorships/get-sponsorship-lifecycle-reasons"},{"openapi":"get /admin/sponsorships/exports/active","title":"List commitment-export jobs currently queued or processing","href":"/api-reference/sponsorships/list-commitment-export-jobs-currently-queued-or-processing"},{"openapi":"get /admin/sponsorship-change-requests","title":"List donor sponsorship approval requests","href":"/api-reference/sponsorships/list-donor-sponsorship-approval-requests"},{"openapi":"get /frontend/donor/dashboard/sponsorship-requests/{client_id}/{program_id}/{session_id}","title":"List donor sponsorship change requests","href":"/api-reference/sponsorships/list-donor-sponsorship-change-requests"},{"openapi":"get /admin/sponsorships/{donor_entity_id}/reassignment-options","title":"List eligible replacement recipients","href":"/api-reference/sponsorships/list-eligible-replacement-recipients"},{"openapi":"get /admin/all_sponsorships","title":"List every commitment for the active client","href":"/api-reference/sponsorships/list-every-commitment-for-the-active-client"},{"openapi":"get /admin/lifecycle-reason-sets","title":"List lifecycle reason standards","href":"/api-reference/sponsorships/list-lifecycle-reason-standards"},{"openapi":"get /admin/donations/{donation_id}/funding","title":"List recipient funding allocated from a gift","href":"/api-reference/sponsorships/list-recipient-funding-allocated-from-a-gift"},{"openapi":"get /admin/recipient-funding/recipients","title":"List recipients eligible for gift funding","href":"/api-reference/sponsorships/list-recipients-eligible-for-gift-funding"},{"openapi":"get /admin/sponsorships/lifecycle/events","title":"List sponsorship lifecycle history","href":"/api-reference/sponsorships/list-sponsorship-lifecycle-history"},{"openapi":"post /admin/show_all_sponsorships","title":"Load legacy commitment table metadata","href":"/api-reference/sponsorships/load-legacy-commitment-table-metadata"},{"openapi":"get /admin/sponsorships/exports/{uploadId}/status","title":"Poll a single commitment-export job","href":"/api-reference/sponsorships/poll-a-single-commitment-export-job"},{"openapi":"post /admin/sponsorships/donor","title":"Post Commitments Next","href":"/api-reference/sponsorships/post-commitments-next"},{"openapi":"post /admin/sponsorships/{donor_entity_id}/reassignment-preview","title":"Preview a sponsorship recipient reassignment","href":"/api-reference/sponsorships/preview-a-sponsorship-recipient-reassignment"},{"openapi":"post /admin/donations/{donation_id}/funding/preview","title":"Preview allocation of a received gift to recipients","href":"/api-reference/sponsorships/preview-allocation-of-a-received-gift-to-recipients"},{"openapi":"post /admin/sponsorship-amount-preview","title":"Preview available fixed sponsorship levels","href":"/api-reference/sponsorships/preview-available-fixed-sponsorship-levels"},{"openapi":"get /admin/sponsorships/{program_id}/export","title":"Queue a CSV export of commitments (async)","href":"/api-reference/sponsorships/queue-a-csv-export-of-commitments-async"},{"openapi":"post /admin/sponsorships/{program_id}/export","title":"Queue a CSV export of commitments (async)","href":"/api-reference/sponsorships/queue-a-csv-export-of-commitments-async-1"},{"openapi":"get /admin/program/entities/{id}/funding","title":"Read a recipient funding history and current coverage","href":"/api-reference/sponsorships/read-a-recipient-funding-history-and-current-coverage"},{"openapi":"post /admin/sponsorships/{donor_entity_id}/reassign","title":"Reassign a sponsorship recipient","href":"/api-reference/sponsorships/reassign-a-sponsorship-recipient"},{"openapi":"post /admin/sponsorship-change-requests/{request_id}/reject","title":"Reject a donor sponsorship change request","href":"/api-reference/sponsorships/reject-a-donor-sponsorship-change-request"},{"openapi":"post /admin/lifecycle-reason-sets/{reason_set_id}/reorder","title":"Reorder a lifecycle reason catalog","href":"/api-reference/sponsorships/reorder-a-lifecycle-reason-catalog"},{"openapi":"post /admin/sponsorships/{donor_entity_id}/restore","title":"Restore one archived sponsorship","href":"/api-reference/sponsorships/restore-one-archived-sponsorship"},{"openapi":"post /admin/sponsorships/restore","title":"Restore selected archived sponsorships","href":"/api-reference/sponsorships/restore-selected-archived-sponsorships"},{"openapi":"post /admin/recipient-funding/{funding_id}/reverse","title":"Reverse a recipient funding allocation","href":"/api-reference/sponsorships/reverse-a-recipient-funding-allocation"},{"openapi":"post /frontend/donor/dashboard/sponsorships/{client_id}/{program_id}/{session_id}/{donor_entity_id}/preview","title":"Review a donor sponsorship change","href":"/api-reference/sponsorships/review-a-donor-sponsorship-change"},{"openapi":"post /admin/commitments/preview","title":"Review bulk commitment changes","href":"/api-reference/sponsorships/review-bulk-commitment-changes"},{"openapi":"get /admin/fields/options/sponsorships","title":"Saved commitment-listing reports for the rule editor","href":"/api-reference/sponsorships/saved-commitment-listing-reports-for-the-rule-editor"},{"openapi":"patch /admin/lifecycle-reason-sets/{reason_set_id}","title":"Set lifecycle reason selection policy","href":"/api-reference/sponsorships/set-lifecycle-reason-selection-policy"},{"openapi":"post /admin/recipient-funding/{funding_id}/end","title":"Shorten a recipient funding period","href":"/api-reference/sponsorships/shorten-a-recipient-funding-period"},{"openapi":"get /admin/sponsorships/program/{program_id}","title":"Show All Sponsorships","href":"/api-reference/sponsorships/show-all-sponsorships"},{"openapi":"get /admin/sponsorships/lifecycle/summary","title":"Summarize sponsorship lifecycle history","href":"/api-reference/sponsorships/summarize-sponsorship-lifecycle-history"},{"openapi":"patch /admin/lifecycle-reasons/{reason_id}","title":"Update a lifecycle reason","href":"/api-reference/sponsorships/update-a-lifecycle-reason"},{"openapi":"post /frontend/donor/dashboard/sponsorship-requests/{client_id}/{program_id}/{session_id}/{request_id}/withdraw","title":"Withdraw a pending sponsorship request","href":"/api-reference/sponsorships/withdraw-a-pending-sponsorship-request"}]},{"group":"Tasks","pages":[{"openapi":"post /admin/tasks/bulk","title":"Change multiple workspace tasks","href":"/api-reference/tasks/change-multiple-workspace-tasks"},{"openapi":"get /admin/collaboration/attachment-uploads/readiness","title":"Check collaboration upload readiness","href":"/api-reference/tasks/check-collaboration-upload-readiness"},{"openapi":"delete /admin/view-state/tasks","title":"Clear the last task workspace view","href":"/api-reference/tasks/clear-the-last-task-workspace-view"},{"openapi":"post /admin/tasks/{task}/complete","title":"Complete a workspace task","href":"/api-reference/tasks/complete-a-workspace-task"},{"openapi":"post /admin/saved-views/tasks","title":"Create a named task view","href":"/api-reference/tasks/create-a-named-task-view"},{"openapi":"post /admin/collaboration/{subjectType}/{subjectId}/comments","title":"Create a record comment","href":"/api-reference/tasks/create-a-record-comment"},{"openapi":"post /admin/tasks","title":"Create a workspace task","href":"/api-reference/tasks/create-a-workspace-task"},{"openapi":"delete /admin/collaboration/{subjectType}/{subjectId}/attachments/{attachmentId}","title":"Delete a collaboration attachment","href":"/api-reference/tasks/delete-a-collaboration-attachment"},{"openapi":"delete /admin/saved-views/tasks/{savedView}","title":"Delete a named task view","href":"/api-reference/tasks/delete-a-named-task-view"},{"openapi":"delete /admin/collaboration/{subjectType}/{subjectId}/comments/{commentId}","title":"Delete a record comment","href":"/api-reference/tasks/delete-a-record-comment"},{"openapi":"delete /admin/collaboration/attachment-uploads/{attachmentId}","title":"Delete a staged task attachment","href":"/api-reference/tasks/delete-a-staged-task-attachment"},{"openapi":"delete /admin/tasks/{task}","title":"Delete a workspace task","href":"/api-reference/tasks/delete-a-workspace-task"},{"openapi":"get /admin/collaboration/{subjectType}/{subjectId}/attachments/{attachmentId}/download","title":"Download a scanned collaboration attachment","href":"/api-reference/tasks/download-a-scanned-collaboration-attachment"},{"openapi":"patch /admin/collaboration/{subjectType}/{subjectId}/comments/{commentId}","title":"Edit a record comment","href":"/api-reference/tasks/edit-a-record-comment"},{"openapi":"get /admin/tasks/exports/calendar","title":"Export workspace tasks to a calendar","href":"/api-reference/tasks/export-workspace-tasks-to-a-calendar"},{"openapi":"get /admin/tasks/exports/csv","title":"Export workspace tasks to CSV","href":"/api-reference/tasks/export-workspace-tasks-to-csv"},{"openapi":"get /admin/tasks/assignees","title":"Find task assignees","href":"/api-reference/tasks/find-task-assignees"},{"openapi":"get /admin/collaboration/{subjectType}/{subjectId}/mention-candidates","title":"Find teammates to mention","href":"/api-reference/tasks/find-teammates-to-mention"},{"openapi":"get /admin/tasks/{task}","title":"Get a workspace task","href":"/api-reference/tasks/get-a-workspace-task"},{"openapi":"post /admin/saved-views/tasks/import","title":"Import named task views","href":"/api-reference/tasks/import-named-task-views"},{"openapi":"get /admin/tasks","title":"List workspace tasks","href":"/api-reference/tasks/list-workspace-tasks"},{"openapi":"get /admin/view-state/tasks","title":"Load task workspace view state","href":"/api-reference/tasks/load-task-workspace-view-state"},{"openapi":"put /admin/collaboration/{subjectType}/{subjectId}/comments/{commentId}/pin","title":"Pin a record comment","href":"/api-reference/tasks/pin-a-record-comment"},{"openapi":"get /admin/collaboration/{subjectType}/{subjectId}","title":"Read a record collaboration thread","href":"/api-reference/tasks/read-a-record-collaboration-thread"},{"openapi":"post /admin/tasks/{task}/reopen","title":"Reopen a workspace task","href":"/api-reference/tasks/reopen-a-workspace-task"},{"openapi":"post /admin/tasks/{task_id}/restore","title":"Restore a deleted workspace task","href":"/api-reference/tasks/restore-a-deleted-workspace-task"},{"openapi":"post /admin/collaboration/{subjectType}/{subjectId}/attachments/{attachmentId}/retry-scan","title":"Retry scanning a collaboration attachment","href":"/api-reference/tasks/retry-scanning-a-collaboration-attachment"},{"openapi":"put /admin/view-state/tasks","title":"Save the last task workspace view","href":"/api-reference/tasks/save-the-last-task-workspace-view"},{"openapi":"get /admin/tasks/records/search","title":"Search related workspace records","href":"/api-reference/tasks/search-related-workspace-records"},{"openapi":"get /admin/tasks/related/search","title":"Search related workspace records","href":"/api-reference/tasks/search-related-workspace-records-1"},{"openapi":"post /admin/collaboration/attachment-uploads","title":"Stage an attachment for a new task","href":"/api-reference/tasks/stage-an-attachment-for-a-new-task"},{"openapi":"delete /admin/collaboration/{subjectType}/{subjectId}/comments/{commentId}/pin","title":"Unpin a record comment","href":"/api-reference/tasks/unpin-a-record-comment"},{"openapi":"put /admin/saved-views/tasks/{savedView}","title":"Update a named task view","href":"/api-reference/tasks/update-a-named-task-view"},{"openapi":"put /admin/tasks/{task}","title":"Update a workspace task","href":"/api-reference/tasks/update-a-workspace-task"},{"openapi":"patch /admin/tasks/{task}","title":"Update a workspace task","href":"/api-reference/tasks/update-a-workspace-task-1"},{"openapi":"post /admin/collaboration/{subjectType}/{subjectId}/attachments","title":"Upload a record collaboration attachment","href":"/api-reference/tasks/upload-a-record-collaboration-attachment"}]},{"group":"Team \u0026 Access","pages":[{"openapi":"post /admin/groups","title":"Create a new Access role","href":"/api-reference/team-\u0026-access/create-a-new-access-role"},{"openapi":"delete /admin/groups/{group_id}","title":"Delete an Access role by ID","href":"/api-reference/team-\u0026-access/delete-an-access-role-by-id"},{"openapi":"put /admin/groups/{group_id}","title":"Edit a specific Access role","href":"/api-reference/team-\u0026-access/edit-a-specific-access-role"},{"openapi":"get /admin/groups/{group_id}","title":"Get an Access role by ID","href":"/api-reference/team-\u0026-access/get-an-access-role-by-id"},{"openapi":"get /admin/createGroup","title":"List a donors and programs","href":"/api-reference/team-\u0026-access/list-a-donors-and-programs"},{"openapi":"get /admin/groups","title":"View all Access roles","href":"/api-reference/team-\u0026-access/view-all-access-roles"}]},{"group":"Trips","pages":[{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/participants/{session_id}","title":"Add a participant to the trip","href":"/api-reference/trips/add-a-participant-to-the-trip"},{"openapi":"post /admin/trips/{tripId}/budget-items","title":"Add a trip budget item","href":"/api-reference/trips/add-a-trip-budget-item"},{"openapi":"post /admin/trips/{tripId}/documents","title":"Add a trip document","href":"/api-reference/trips/add-a-trip-document"},{"openapi":"post /admin/trips/{tripId}/participants","title":"Add a trip participant","href":"/api-reference/trips/add-a-trip-participant"},{"openapi":"post /admin/trips/{tripId}/apply-template/{templateId}","title":"Apply a task template to a trip","href":"/api-reference/trips/apply-a-task-template-to-a-trip"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/apply-template/{template_id}/{session_id}","title":"Apply a task template to the trip","href":"/api-reference/trips/apply-a-task-template-to-the-trip"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/completions/{completion_id}/approve/{session_id}","title":"Approve a task completion","href":"/api-reference/trips/approve-a-task-completion"},{"openapi":"post /admin/trips/{tripId}/tasks/completions/{completionId}/approve","title":"Approve a trip task submission","href":"/api-reference/trips/approve-a-trip-task-submission"},{"openapi":"post /admin/trips/{id}/archive","title":"Archive a trip","href":"/api-reference/trips/archive-a-trip"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/documents/{document_id}/download/{session_id}","title":"Audited download for a trip document","href":"/api-reference/trips/audited-download-for-a-trip-document"},{"openapi":"post /admin/trips/{id}/clone","title":"Clone a trip","href":"/api-reference/trips/clone-a-trip"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/budget-items/{session_id}","title":"Create a budget line item","href":"/api-reference/trips/create-a-budget-line-item"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/milestones/{session_id}","title":"Create a fundraising milestone","href":"/api-reference/trips/create-a-fundraising-milestone"},{"openapi":"post /admin/trips/sample","title":"Create a sample trip","href":"/api-reference/trips/create-a-sample-trip"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/task-templates/{session_id}","title":"Create a task template","href":"/api-reference/trips/create-a-task-template"},{"openapi":"post /admin/trips","title":"Create a trip","href":"/api-reference/trips/create-a-trip"},{"openapi":"post /admin/trips/{tripId}/milestones","title":"Create a trip fundraising milestone","href":"/api-reference/trips/create-a-trip-fundraising-milestone"},{"openapi":"post /admin/trips/{tripId}/tasks","title":"Create a trip task","href":"/api-reference/trips/create-a-trip-task"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}","title":"Create a trip task","href":"/api-reference/trips/create-a-trip-task-1"},{"openapi":"post /admin/trip-task-templates","title":"Create a trip task template","href":"/api-reference/trips/create-a-trip-task-template"},{"openapi":"post /admin/trips/{tripId}/esignatures/templates/embedded-draft","title":"Create an embedded signature template draft","href":"/api-reference/trips/create-an-embedded-signature-template-draft"},{"openapi":"delete /frontend/participant/trips/{client_id}/{trip_id}/leader/budget-items/{item_id}/{session_id}","title":"Delete a budget line item","href":"/api-reference/trips/delete-a-budget-line-item"},{"openapi":"delete /frontend/participant/trips/{client_id}/{trip_id}/leader/milestones/{id}/{session_id}","title":"Delete a fundraising milestone","href":"/api-reference/trips/delete-a-fundraising-milestone"},{"openapi":"delete /admin/trips/{tripId}/esignatures/templates/{templateId}","title":"Delete a signature template","href":"/api-reference/trips/delete-a-signature-template"},{"openapi":"delete /frontend/participant/trips/{client_id}/{trip_id}/leader/task-templates/{template_id}/{session_id}","title":"Delete a task template","href":"/api-reference/trips/delete-a-task-template"},{"openapi":"delete /admin/trips/{id}","title":"Delete a trip","href":"/api-reference/trips/delete-a-trip"},{"openapi":"delete /admin/trips/{tripId}/budget-items/{id}","title":"Delete a trip budget item","href":"/api-reference/trips/delete-a-trip-budget-item"},{"openapi":"delete /admin/trips/{tripId}/documents/{id}","title":"Delete a trip document","href":"/api-reference/trips/delete-a-trip-document"},{"openapi":"delete /admin/trips/{tripId}/milestones/{id}","title":"Delete a trip fundraising milestone","href":"/api-reference/trips/delete-a-trip-fundraising-milestone"},{"openapi":"delete /admin/trips/{tripId}/tasks/{taskId}","title":"Delete a trip task","href":"/api-reference/trips/delete-a-trip-task"},{"openapi":"delete /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{task_id}/{session_id}","title":"Delete a trip task","href":"/api-reference/trips/delete-a-trip-task-1"},{"openapi":"delete /admin/trip-task-templates/{id}","title":"Delete a trip task template","href":"/api-reference/trips/delete-a-trip-task-template"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/donations/{session_id}","title":"Donations targeted at this participant","href":"/api-reference/trips/donations-targeted-at-this-participant"},{"openapi":"get /admin/trips/{tripId}/analytics/exports/donations","title":"Export trip donations","href":"/api-reference/trips/export-trip-donations"},{"openapi":"get /admin/trips/{tripId}/analytics/exports/participants","title":"Export trip participants","href":"/api-reference/trips/export-trip-participants"},{"openapi":"get /admin/trips/{tripId}/analytics/exports/tasks","title":"Export trip task progress","href":"/api-reference/trips/export-trip-task-progress"},{"openapi":"get /admin/trips/{tripId}/esignatures/{requestId}/signed-document","title":"Get a signed trip document URL","href":"/api-reference/trips/get-a-signed-trip-document-url"},{"openapi":"get /admin/trips/{tripId}/budget-items/{id}","title":"Get a trip budget item","href":"/api-reference/trips/get-a-trip-budget-item"},{"openapi":"get /admin/trips/{tripId}/messages/{id}","title":"Get a trip communication","href":"/api-reference/trips/get-a-trip-communication"},{"openapi":"get /admin/trips/{tripId}/documents/{id}/download","title":"Get a trip document download URL","href":"/api-reference/trips/get-a-trip-document-download-url"},{"openapi":"get /admin/trips/{tripId}/participants/{id}","title":"Get a trip participant","href":"/api-reference/trips/get-a-trip-participant"},{"openapi":"get /admin/trip-task-templates/{id}","title":"Get a trip task template","href":"/api-reference/trips/get-a-trip-task-template"},{"openapi":"get /admin/trips/{id}","title":"Get a trip with setup details","href":"/api-reference/trips/get-a-trip-with-setup-details"},{"openapi":"get /admin/trips/{tripId}/esignatures/templates/{templateId}/embedded-edit-url","title":"Get an embedded signature template edit URL","href":"/api-reference/trips/get-an-embedded-signature-template-edit-url"},{"openapi":"get /admin/trips/{id}/public-url","title":"Get the public trip URL","href":"/api-reference/trips/get-the-public-trip-url"},{"openapi":"get /admin/trips/{tripId}/analytics","title":"Get trip analytics","href":"/api-reference/trips/get-trip-analytics"},{"openapi":"post /admin/trips/{tripId}/participants/import","title":"Import trip participants","href":"/api-reference/trips/import-trip-participants"},{"openapi":"post /admin/trips/{tripId}/participants/{id}/background-checks","title":"Initiate a trip participant background check","href":"/api-reference/trips/initiate-a-trip-participant-background-check"},{"openapi":"post /admin/trips/{tripId}/participants/invite","title":"Invite active trip participants","href":"/api-reference/trips/invite-active-trip-participants"},{"openapi":"get /admin/trips/{tripId}/esignatures/templates","title":"List available signature templates","href":"/api-reference/trips/list-available-signature-templates"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/milestones/{session_id}","title":"List fundraising milestones","href":"/api-reference/trips/list-fundraising-milestones"},{"openapi":"get /admin/trips","title":"List organization trips","href":"/api-reference/trips/list-organization-trips"},{"openapi":"get /admin/trips/{tripId}/tasks/{taskId}/participants","title":"List participant progress for a trip task","href":"/api-reference/trips/list-participant-progress-for-a-trip-task"},{"openapi":"get /admin/trips/{tripId}/messages/{id}/replies","title":"List replies to a trip message","href":"/api-reference/trips/list-replies-to-a-trip-message"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/task-templates/{session_id}","title":"List task templates for the client","href":"/api-reference/trips/list-task-templates-for-the-client"},{"openapi":"get /admin/trips/{tripId}/budget-items","title":"List trip budget items","href":"/api-reference/trips/list-trip-budget-items"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/budget-items/{session_id}","title":"List trip budget items","href":"/api-reference/trips/list-trip-budget-items-1"},{"openapi":"get /admin/trips/{tripId}/messages","title":"List trip communications","href":"/api-reference/trips/list-trip-communications"},{"openapi":"get /admin/trips/{tripId}/documents","title":"List trip documents","href":"/api-reference/trips/list-trip-documents"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/documents/{session_id}","title":"List trip documents the participant can see","href":"/api-reference/trips/list-trip-documents-the-participant-can-see"},{"openapi":"get /admin/trips/{tripId}/milestones","title":"List trip fundraising milestones","href":"/api-reference/trips/list-trip-fundraising-milestones"},{"openapi":"get /admin/trips/{tripId}/participants","title":"List trip participants","href":"/api-reference/trips/list-trip-participants"},{"openapi":"get /admin/trips/{tripId}/esignatures","title":"List trip signature requests","href":"/api-reference/trips/list-trip-signature-requests"},{"openapi":"get /admin/trips/{tripId}/tasks/completions","title":"List trip task submissions","href":"/api-reference/trips/list-trip-task-submissions"},{"openapi":"get /admin/trip-task-templates","title":"List trip task templates","href":"/api-reference/trips/list-trip-task-templates"},{"openapi":"get /admin/trips/{tripId}/tasks","title":"List trip tasks","href":"/api-reference/trips/list-trip-tasks"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/tasks/{session_id}","title":"List trip tasks assigned to the participant","href":"/api-reference/trips/list-trip-tasks-assigned-to-the-participant"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{session_id}","title":"List trip tasks for the leader","href":"/api-reference/trips/list-trip-tasks-for-the-leader"},{"openapi":"get /frontend/participant/trips/{client_id}/{session_id}","title":"List trips the donor is an active participant in","href":"/api-reference/trips/list-trips-the-donor-is-an-active-participant-in"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/tasks/{task_id}/complete/{session_id}","title":"Mark a participant task as complete","href":"/api-reference/trips/mark-a-participant-task-as-complete"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/completions/{session_id}","title":"Paginated task completions for the trip","href":"/api-reference/trips/paginated-task-completions-for-the-trip"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/participants/{session_id}","title":"Participant roster with fundraising progress","href":"/api-reference/trips/participant-roster-with-fundraising-progress"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{task_id}/participants/{session_id}","title":"Per-task participant completion status","href":"/api-reference/trips/per-task-participant-completion-status"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/public-url/{session_id}","title":"Public URL for the trip","href":"/api-reference/trips/public-url-for-the-trip"},{"openapi":"post /admin/trips/{tripId}/messages/send","title":"Queue a trip message","href":"/api-reference/trips/queue-a-trip-message"},{"openapi":"post /admin/trips/{tripId}/analytics/reload","title":"Queue trip analytics refresh","href":"/api-reference/trips/queue-trip-analytics-refresh"},{"openapi":"get /admin/trip-settings","title":"Read organization trip defaults","href":"/api-reference/trips/read-organization-trip-defaults"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/completions/{completion_id}/reject/{session_id}","title":"Reject a task completion","href":"/api-reference/trips/reject-a-task-completion"},{"openapi":"post /admin/trips/{tripId}/tasks/completions/{completionId}/reject","title":"Reject a trip task submission","href":"/api-reference/trips/reject-a-trip-task-submission"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/budget-items/reorder/{session_id}","title":"Reorder budget items","href":"/api-reference/trips/reorder-budget-items"},{"openapi":"post /admin/trips/{tripId}/budget-items/reorder","title":"Reorder trip budget items","href":"/api-reference/trips/reorder-trip-budget-items"},{"openapi":"post /admin/trips/{tripId}/esignatures/{requestId}/resend","title":"Resend a trip signature request","href":"/api-reference/trips/resend-a-trip-signature-request"},{"openapi":"post /admin/trips/{id}/restore","title":"Restore a trip","href":"/api-reference/trips/restore-a-trip"},{"openapi":"post /admin/trips/{tripId}/messages","title":"Save a trip communication draft or log","href":"/api-reference/trips/save-a-trip-communication-draft-or-log"},{"openapi":"get /frontend/participant/trips/{client_id}/leader/donors/search/{session_id}","title":"Search client donors as a leader","href":"/api-reference/trips/search-client-donors-as-a-leader"},{"openapi":"get /admin/donors/search","title":"Search donors for trip participation","href":"/api-reference/trips/search-donors-for-trip-participation"},{"openapi":"post /admin/trips/{tripId}/participants/{id}/esignatures","title":"Send a participant signature request","href":"/api-reference/trips/send-a-participant-signature-request"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/participants/invite/{session_id}","title":"Send invitations to participants","href":"/api-reference/trips/send-invitations-to-participants"},{"openapi":"post /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{task_id}/remind/{session_id}","title":"Send manual task reminder","href":"/api-reference/trips/send-manual-task-reminder"},{"openapi":"post /admin/trips/{tripId}/esignatures/batch-send","title":"Send trip signature requests in a batch","href":"/api-reference/trips/send-trip-signature-requests-in-a-batch"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/{session_id}","title":"Trip detail + participant progress","href":"/api-reference/trips/trip-detail-+-participant-progress"},{"openapi":"get /frontend/participant/trips/{client_id}/{trip_id}/leader/{session_id}","title":"Trip Leader Console — trip view + effective permissions","href":"/api-reference/trips/trip-leader-console-—-trip-view-+-effective-permissions"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/budget-items/{item_id}/{session_id}","title":"Update a budget line item","href":"/api-reference/trips/update-a-budget-line-item"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/milestones/{id}/{session_id}","title":"Update a fundraising milestone","href":"/api-reference/trips/update-a-fundraising-milestone"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/task-templates/{template_id}/{session_id}","title":"Update a task template","href":"/api-reference/trips/update-a-task-template"},{"openapi":"put /admin/trips/{id}","title":"Update a trip","href":"/api-reference/trips/update-a-trip"},{"openapi":"put /admin/trips/{tripId}/budget-items/{id}","title":"Update a trip budget item","href":"/api-reference/trips/update-a-trip-budget-item"},{"openapi":"put /admin/trips/{tripId}/documents/{id}","title":"Update a trip document","href":"/api-reference/trips/update-a-trip-document"},{"openapi":"put /admin/trips/{tripId}/milestones/{id}","title":"Update a trip fundraising milestone","href":"/api-reference/trips/update-a-trip-fundraising-milestone"},{"openapi":"put /admin/trips/{tripId}/participants/{id}","title":"Update a trip participant","href":"/api-reference/trips/update-a-trip-participant"},{"openapi":"put /admin/trips/{tripId}/tasks/{taskId}","title":"Update a trip task","href":"/api-reference/trips/update-a-trip-task"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/tasks/{task_id}/{session_id}","title":"Update a trip task","href":"/api-reference/trips/update-a-trip-task-1"},{"openapi":"put /admin/trip-task-templates/{id}","title":"Update a trip task template","href":"/api-reference/trips/update-a-trip-task-template"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/participants/{trip_participant_id}/{session_id}","title":"Update an existing participant","href":"/api-reference/trips/update-an-existing-participant"},{"openapi":"put /admin/trip-settings","title":"Update organization trip defaults","href":"/api-reference/trips/update-organization-trip-defaults"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/profile/{session_id}","title":"Update the participant's public profile","href":"/api-reference/trips/update-the-participants-public-profile"},{"openapi":"put /frontend/participant/trips/{client_id}/{trip_id}/leader/{session_id}","title":"Update trip details as leader","href":"/api-reference/trips/update-trip-details-as-leader"},{"openapi":"delete /frontend/participant/trips/{client_id}/{trip_id}/leader/participants/{trip_participant_id}/{session_id}","title":"Withdraw a participant","href":"/api-reference/trips/withdraw-a-participant"},{"openapi":"delete /admin/trips/{tripId}/participants/{id}","title":"Withdraw a trip participant","href":"/api-reference/trips/withdraw-a-trip-participant"}]},{"group":"User","pages":[{"openapi":"post /admin/signup/step_one","title":"User Signup Step One","href":"/api-reference/user/user-signup-step-one"},{"openapi":"post /admin/signup/step_three","title":"User Signup Step Three","href":"/api-reference/user/user-signup-step-three"},{"openapi":"post /admin/signup/step_two","title":"User Signup Step Two","href":"/api-reference/user/user-signup-step-two"}]},{"group":"Users","pages":[{"openapi":"get /admin/team-roles","title":"List team profile roles","href":"/api-reference/users/list-team-profile-roles"},{"openapi":"post /admin/team-member-profile/snooze","title":"Snooze my team profile reminder","href":"/api-reference/users/snooze-my-team-profile-reminder"},{"openapi":"put /admin/team-member-profile","title":"Update my team profile","href":"/api-reference/users/update-my-team-profile"}]},{"group":"Webhooks","pages":[{"openapi":"post /silent_post","title":"Authorize.Net ARB silent-post receiver","href":"/api-reference/webhooks/authorizenet-arb-silent-post-receiver"},{"openapi":"post /activities/email-ingest","title":"Mailgun inbound email webhook","href":"/api-reference/webhooks/mailgun-inbound-email-webhook"}]},{"group":"Workspace","pages":[{"openapi":"post /workspace-onboarding/invite/exchange","title":"Authenticate a direct workspace invitation","href":"/api-reference/workspace/authenticate-a-direct-workspace-invitation"},{"openapi":"put /workspace-onboarding/{public_id}/organization","title":"Confirm the new workspace organization","href":"/api-reference/workspace/confirm-the-new-workspace-organization"},{"openapi":"put /workspace-onboarding/{public_id}/intent","title":"Confirm workspace setup choices","href":"/api-reference/workspace/confirm-workspace-setup-choices"},{"openapi":"post /workspace-onboarding/{public_id}/finalize","title":"Create the verified workspace and sign in","href":"/api-reference/workspace/create-the-verified-workspace-and-sign-in"},{"openapi":"get /workspace-onboarding/{public_id}","title":"Get a resumable workspace setup session","href":"/api-reference/workspace/get-a-resumable-workspace-setup-session"},{"openapi":"get /workspace-onboarding/entry","title":"Get workspace signup entry options","href":"/api-reference/workspace/get-workspace-signup-entry-options"},{"openapi":"post /workspace-onboarding/{public_id}/organization-lookup","title":"Look up a nonprofit during workspace setup","href":"/api-reference/workspace/look-up-a-nonprofit-during-workspace-setup"},{"openapi":"post /workspace-onboarding/{public_id}/payment-intent","title":"Prepare workspace card verification","href":"/api-reference/workspace/prepare-workspace-card-verification"},{"openapi":"get /workspace-onboarding/invite","title":"Preview a workspace invitation","href":"/api-reference/workspace/preview-a-workspace-invitation"},{"openapi":"post /workspace-onboarding/{public_id}/organization-enrichment","title":"Preview organization website suggestions","href":"/api-reference/workspace/preview-organization-website-suggestions"},{"openapi":"post /workspace-onboarding/payment-return/exchange","title":"Resume workspace setup after payment verification","href":"/api-reference/workspace/resume-workspace-setup-after-payment-verification"},{"openapi":"post /workspace-onboarding/self-serve/request-code","title":"Send a public workspace signup code","href":"/api-reference/workspace/send-a-public-workspace-signup-code"},{"openapi":"post /workspace-onboarding/invite/request-code","title":"Send a workspace invitation verification code","href":"/api-reference/workspace/send-a-workspace-invitation-verification-code"},{"openapi":"post /workspace-onboarding/self-serve/verify-code","title":"Verify a public workspace signup code","href":"/api-reference/workspace/verify-a-public-workspace-signup-code"},{"openapi":"post /workspace-onboarding/invite/verify-code","title":"Verify a workspace invitation code","href":"/api-reference/workspace/verify-a-workspace-invitation-code"},{"openapi":"post /workspace-onboarding/{public_id}/verify-payment","title":"Verify the workspace payment method","href":"/api-reference/workspace/verify-the-workspace-payment-method"}]},{"group":"Wrapped","pages":[{"openapi":"get /admin/wrapped/{year}/status","title":"Check calculation status for wrapped statistics","href":"/api-reference/wrapped/check-calculation-status-for-wrapped-statistics"},{"openapi":"get /wrapped/{year}/public/{token}/exists","title":"Check if a public wrapped report exists","href":"/api-reference/wrapped/check-if-a-public-wrapped-report-exists"},{"openapi":"post /admin/wrapped/{year}/email","title":"Email the wrapped report to the admin","href":"/api-reference/wrapped/email-the-wrapped-report-to-the-admin"},{"openapi":"post /admin/wrapped/{year}/share","title":"Generate or toggle public sharing link for wrapped report","href":"/api-reference/wrapped/generate-or-toggle-public-sharing-link-for-wrapped-report"},{"openapi":"get /admin/wrapped/{year}","title":"Get organization's year in review","href":"/api-reference/wrapped/get-organizations-year-in-review"},{"openapi":"get /wrapped/{year}/public/{token}","title":"Get public wrapped report by share token","href":"/api-reference/wrapped/get-public-wrapped-report-by-share-token"}]},{"group":"Zapier","pages":[{"openapi":"patch /zapier/actions/commitments/{id}/status","title":"Archive or restore a commitment through Zapier","href":"/api-reference/zapier/archive-or-restore-a-commitment-through-zapier"},{"openapi":"post /zapier/actions/commitments/{id}/cancel","title":"Cancel a commitment through Zapier","href":"/api-reference/zapier/cancel-a-commitment-through-zapier"},{"openapi":"post /zapier/actions/donors","title":"Create a donor through Zapier","href":"/api-reference/zapier/create-a-donor-through-zapier"},{"openapi":"post /zapier/actions/notes","title":"Create a profile note through Zapier","href":"/api-reference/zapier/create-a-profile-note-through-zapier"},{"openapi":"post /zapier/actions/recipients","title":"Create a recipient through Zapier","href":"/api-reference/zapier/create-a-recipient-through-zapier"},{"openapi":"post /zapier/actions/sponsorships","title":"Create an externally managed sponsorship","href":"/api-reference/zapier/create-an-externally-managed-sponsorship"},{"openapi":"get /zapier/compat/template","title":"Get the Zapier compatibility template","href":"/api-reference/zapier/get-the-zapier-compatibility-template"},{"openapi":"get /zapier/triggers/commitments/fields","title":"Get Zapier commitment field definitions","href":"/api-reference/zapier/get-zapier-commitment-field-definitions"},{"openapi":"get /zapier/triggers/commitments/cancelled-feed","title":"List commitment cancellation events for Zapier","href":"/api-reference/zapier/list-commitment-cancellation-events-for-zapier"},{"openapi":"get /zapier/triggers/donations/created-feed","title":"List newly inserted donations for Zapier","href":"/api-reference/zapier/list-newly-inserted-donations-for-zapier"},{"openapi":"get /zapier/triggers/commitments/feed","title":"List updated commitments for Zapier","href":"/api-reference/zapier/list-updated-commitments-for-zapier"},{"openapi":"get /zapier/triggers/donations/feed","title":"List updated donations for Zapier","href":"/api-reference/zapier/list-updated-donations-for-zapier"},{"openapi":"get /zapier/triggers/donors/feed","title":"List updated donors for Zapier","href":"/api-reference/zapier/list-updated-donors-for-zapier"},{"openapi":"get /zapier/triggers/notes/feed","title":"List updated notes for Zapier","href":"/api-reference/zapier/list-updated-notes-for-zapier"},{"openapi":"get /zapier/triggers/recipients/feed","title":"List updated recipients for Zapier","href":"/api-reference/zapier/list-updated-recipients-for-zapier"},{"openapi":"post /zapier/actions/donations","title":"Record a donation through Zapier","href":"/api-reference/zapier/record-a-donation-through-zapier"},{"openapi":"post /zapier/actions/commitments/{id}/offline-payments","title":"Record an offline commitment payment","href":"/api-reference/zapier/record-an-offline-commitment-payment"},{"openapi":"post /zapier/actions/sponsorships/{id}/offline-payments","title":"Record an offline sponsorship payment","href":"/api-reference/zapier/record-an-offline-sponsorship-payment"},{"openapi":"get /zapier/searches/commitments","title":"Search commitments for Zapier","href":"/api-reference/zapier/search-commitments-for-zapier"},{"openapi":"get /zapier/searches/donations","title":"Search donations for Zapier","href":"/api-reference/zapier/search-donations-for-zapier"},{"openapi":"get /zapier/searches/donors","title":"Search donors for Zapier","href":"/api-reference/zapier/search-donors-for-zapier"},{"openapi":"get /zapier/searches/forms","title":"Search forms for Zapier","href":"/api-reference/zapier/search-forms-for-zapier"},{"openapi":"get /zapier/searches/programs","title":"Search programs for Zapier","href":"/api-reference/zapier/search-programs-for-zapier"},{"openapi":"get /zapier/searches/recipients","title":"Search recipients for Zapier","href":"/api-reference/zapier/search-recipients-for-zapier"},{"openapi":"get /zapier/auth/test","title":"Test a Zapier connection","href":"/api-reference/zapier/test-a-zapier-connection"},{"openapi":"patch /zapier/actions/donors/{id}","title":"Update a donor through Zapier","href":"/api-reference/zapier/update-a-donor-through-zapier"},{"openapi":"patch /zapier/actions/recipients/{id}","title":"Update a recipient through Zapier","href":"/api-reference/zapier/update-a-recipient-through-zapier"}]}]}]},"title":"Redeem an administrator activation link - Gratona Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-kQh739Uz.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}