Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.
Path Parameters
campaignId
string
required
Response
Successful response
campaignId
string
required
status
enum<string>
required
Campaign lifecycle status.
Available options:
draft,
pending_approval,
scheduled,
sending,
paused,
completed,
cancelled,
failed
totalRecipients
number
required
queuedCount
number
required
sendingCount
number
required
sentCount
number
required
deliveredCount
number
required
openedCount
number
required
clickedCount
number
required
bouncedCount
number
required
complainedCount
number
required
failedCount
number
required
suppressedCount
number
required
unsubscribedCount
number
required
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Dench Docs","colors":{"primary":"#2b6ea0","light":"#6ba8da","dark":"#1f5c8c"},"logo":{"light":"https://mintcdn.com/denchcom/LB9L0GJ1BcgdJzOc/images/dench-workspace-icon.png?fit=max\u0026auto=format\u0026n=LB9L0GJ1BcgdJzOc\u0026q=85\u0026s=06efb34421d431ec3951b1a9b09ba830","dark":"https://mintcdn.com/denchcom/LB9L0GJ1BcgdJzOc/images/dench-workspace-icon.png?fit=max\u0026auto=format\u0026n=LB9L0GJ1BcgdJzOc\u0026q=85\u0026s=06efb34421d431ec3951b1a9b09ba830"},"favicon":"https://mintcdn.com/denchcom/LB9L0GJ1BcgdJzOc/images/dench-workspace-icon.png?fit=max\u0026auto=format\u0026n=LB9L0GJ1BcgdJzOc\u0026q=85\u0026s=06efb34421d431ec3951b1a9b09ba830","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"https://dench.com/email/support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dench.com/login"}},"footer":{"socials":{"x":"https://x.com/DenchHQ","github":"https://github.com/DenchHQ","linkedin":"https://linkedin.com/company/denchhq","discord":"https://discord.gg/PDFXNVQj9n","website":"https://dench.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"denchcom","hasAudioNarration":false,"actualSubdomain":"denchcom","customDomains":["dench.com"],"gitSource":{"type":"github","owner":"denchhq","repo":"dench.com","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b00e98a6ee7063bd47164bc","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":444},{"language":"default","tag":"crm","count":152},{"language":"default","tag":"campaigns","count":67},{"language":"default","tag":"email","count":54},{"language":"default","tag":"gateway","count":28},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"agent-config","count":17},{"language":"default","tag":"apps","count":14},{"language":"default","tag":"meetings","count":13},{"language":"default","tag":"lists","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/email/cancel-campaign","slug":"/api-reference/email/cancel-campaign","pageMetadata":{"title":"Cancel campaign","description":"Cancel an email campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/cancel","href":"/api-reference/email/cancel-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Cancel an email campaign.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{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":{"title":"Cancel campaign","description":"Cancel an email campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/cancel","href":"/api-reference/email/cancel-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"email_campaign_cancel","tags":["email"],"summary":"Cancel campaign","description":"Cancel an email campaign.","parameters":["afac601a-331c-45a4-83dd-d86c8f2f087a"],"security":["70ad07dc-8669-4714-b82f-1b3716244862","f9aac5c3-170d-4c8a-8d4a-12a980304107"],"responses":{"200":"461b6418-8f73-40ca-a520-09b092841fe1","400":"d4a7b424-0f6f-4e24-90b4-b67c295b8b55","401":"60b60990-83b2-4493-91c3-37a984f0f483","404":"5d7a186f-4126-4f69-81c6-7f33ea51b430","500":"95c2806c-3bc4-4488-b335-8968c8fc5689"},"method":"post","type":"path","servers":["d18e4161-62ab-451e-a7a8-bb9052263bad"],"path":"/email/campaigns/{campaignId}/cancel","baseUrlOptions":["https://www.dench.com/api/v1"],"title":"Cancel campaign","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"afac601a-331c-45a4-83dd-d86c8f2f087a":{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"461b6418-8f73-40ca-a520-09b092841fe1":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string","isRequired":true,"uniqueKey":"campaignId","typeLabel":"string"},"status":{"type":"string","enum":["draft","pending_approval","scheduled","sending","paused","completed","cancelled","failed"],"description":"Campaign lifecycle status.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"totalRecipients":{"type":"number","isRequired":true,"uniqueKey":"totalRecipients","typeLabel":"number"},"queuedCount":{"type":"number","isRequired":true,"uniqueKey":"queuedCount","typeLabel":"number"},"sendingCount":{"type":"number","isRequired":true,"uniqueKey":"sendingCount","typeLabel":"number"},"sentCount":{"type":"number","isRequired":true,"uniqueKey":"sentCount","typeLabel":"number"},"deliveredCount":{"type":"number","isRequired":true,"uniqueKey":"deliveredCount","typeLabel":"number"},"openedCount":{"type":"number","isRequired":true,"uniqueKey":"openedCount","typeLabel":"number"},"clickedCount":{"type":"number","isRequired":true,"uniqueKey":"clickedCount","typeLabel":"number"},"bouncedCount":{"type":"number","isRequired":true,"uniqueKey":"bouncedCount","typeLabel":"number"},"complainedCount":{"type":"number","isRequired":true,"uniqueKey":"complainedCount","typeLabel":"number"},"failedCount":{"type":"number","isRequired":true,"uniqueKey":"failedCount","typeLabel":"number"},"suppressedCount":{"type":"number","isRequired":true,"uniqueKey":"suppressedCount","typeLabel":"number"},"unsubscribedCount":{"type":"number","isRequired":true,"uniqueKey":"unsubscribedCount","typeLabel":"number"}},"required":["campaignId","status","totalRecipients","queuedCount","sendingCount","sentCount","deliveredCount","openedCount","clickedCount","bouncedCount","complainedCount","failedCount","suppressedCount","unsubscribedCount"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"campaignId":"ecmp_abc123","status":"cancelled","totalRecipients":120,"queuedCount":70,"sendingCount":0,"sentCount":50,"deliveredCount":48,"openedCount":12,"clickedCount":3,"bouncedCount":1,"complainedCount":0,"failedCount":0,"suppressedCount":2,"unsubscribedCount":0},"examples":{"Example":{"title":"Example","value":{"campaignId":"ecmp_abc123","status":"cancelled","totalRecipients":120,"queuedCount":70,"sendingCount":0,"sentCount":50,"deliveredCount":48,"openedCount":12,"clickedCount":3,"bouncedCount":1,"complainedCount":0,"failedCount":0,"suppressedCount":2,"unsubscribedCount":0}}},"exampleType":"examples"}},"exampleType":"examples"},"d4a7b424-0f6f-4e24-90b4-b67c295b8b55":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"60b60990-83b2-4493-91c3-37a984f0f483":{"description":"Missing or invalid authentication","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5d7a186f-4126-4f69-81c6-7f33ea51b430":{"description":"Operation or resource not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"95c2806c-3bc4-4488-b335-8968c8fc5689":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["message","type","code"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"70ad07dc-8669-4714-b82f-1b3716244862":{"DenchApiKey":{"type":"http","scheme":"bearer","bearerFormat":"DENCH_API_KEY","description":"Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.","scopes":[],"schemeName":"DenchApiKey"}},"f9aac5c3-170d-4c8a-8d4a-12a980304107":{"AgentSession":{"type":"http","scheme":"bearer","bearerFormat":"dch_agent_*","description":"Agent session token created by `dench signin`. Gateway-backed routes exchange this token for the workspace gateway key.","scopes":[],"schemeName":"AgentSession"}}},"servers":{"d18e4161-62ab-451e-a7a8-bb9052263bad":{"url":"https://www.dench.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"DENCH_API_KEY","description":"Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.","scopes":[],"schemeName":"DenchApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"DenchApiKey","name":"Authorization"}],"title":"DenchApiKey"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"dch_agent_*","description":"Agent session token created by `dench signin`. Gateway-backed routes exchange this token for the workspace gateway key.","scopes":[],"schemeName":"AgentSession"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Agent session token created by `dench signin`. Gateway-backed routes exchange this token for the workspace gateway key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AgentSession","name":"Authorization"}],"title":"AgentSession"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"denchcom","siteName":"Dench Docs","title":"Cancel campaign - Dench Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T00:40:14.254Z","originalFileLocation":"api-reference/email/cancel-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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=\"Cancel an email campaign.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dench Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_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=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel campaign - Dench Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel an email campaign.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dench Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dench.com/docs/api-reference/email/cancel-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://denchcom.mintlify.site/docs/_mintlify/api/og/v2?division=email\u0026amp;title=Cancel+campaign\u0026amp;description=Cancel+an+email+campaign.\u0026amp;theme=fdc7c6c872289f4c43bae466\u0026amp;signature=333abfd001326375eab967ef81a39f5a8cf5d8190a0ea158f23459faeb096f7d\">\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=\"Cancel campaign - Dench Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel an email campaign.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://denchcom.mintlify.site/docs/_mintlify/api/og/v2?division=email\u0026amp;title=Cancel+campaign\u0026amp;description=Cancel+an+email+campaign.\u0026amp;theme=fdc7c6c872289f4c43bae466\u0026amp;signature=333abfd001326375eab967ef81a39f5a8cf5d8190a0ea158f23459faeb096f7d\">\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=\"/docs/mintlify-assets/_mintlify/favicons/denchcom/NTYoVXV0I2dRee8x/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dench Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2b6ea0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dench.com/docs/api-reference/email/cancel-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/email/cancel-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dench.com/#organization\",\"name\":\"Dench Docs\",\"url\":\"https://dench.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/denchcom/LB9L0GJ1BcgdJzOc/images/dench-workspace-icon.png?fit=max\u0026auto=format\u0026n=LB9L0GJ1BcgdJzOc\u0026q=85\u0026s=06efb34421d431ec3951b1a9b09ba830\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dench.com/docs#website\",\"name\":\"Dench Docs\",\"url\":\"https://dench.com/docs\",\"publisher\":{\"@id\":\"https://dench.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dench.com/docs/api-reference/email/cancel-campaign#webpage\",\"url\":\"https://dench.com/docs/api-reference/email/cancel-campaign\",\"name\":\"Cancel campaign\",\"description\":\"Cancel an email campaign.\",\"dateModified\":\"2026-11-21T00:40:14.254Z\",\"isPartOf\":{\"@id\":\"https://dench.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://dench.com/docs/api-reference/email/cancel-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dench.com/docs/api-reference/email/cancel-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"email\",\"item\":\"https://dench.com/docs/api-reference/email/verify-sender\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel campaign\",\"item\":\"https://dench.com/docs/api-reference/email/cancel-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dench.com/docs/api-reference/email/cancel-campaign#apireference\",\"headline\":\"Cancel campaign\",\"name\":\"Cancel campaign\",\"description\":\"Cancel an email campaign.\",\"url\":\"https://dench.com/docs/api-reference/email/cancel-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://dench.com/docs/api-reference/email/cancel-campaign#webpage\"},\"dateModified\":\"2026-11-21T00:40:14.254Z\",\"publisher\":{\"@id\":\"https://dench.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dench.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dench Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dench Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/email/cancel-campaign.md","siteName":"Dench Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"environments","pages":[{"title":"List workspace-shared reusable setups and ready revisions (metadata only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /environments","href":"/api-reference/environments/list-workspace-shared-reusable-setups-and-ready-revisions-metadata-only"},{"title":"Inspect a saved setup, its manifest, and an optional immutable revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /environments/{name}","href":"/api-reference/environments/inspect-a-saved-setup-its-manifest-and-an-optional-immutable-revision"},{"title":"Publish an explicitly saved source and manifest for one-time preparation. Returns pending/building until verified; does not run the task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /environments/{name}","href":"/api-reference/environments/publish-an-explicitly-saved-source-and-manifest-for-one-time-preparation-returns-pendingbuilding-until-verified;-does-not-run-the-task"},{"title":"Retire a saved setup from new selection; retain immutable revisions and active job evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /environments/{name}","href":"/api-reference/environments/retire-a-saved-setup-from-new-selection;-retain-immutable-revisions-and-active-job-evidence"},{"title":"Reserve an owner-bound source upload. Prefix the uploaded bytes with the returned proof before saving","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /environments/uploads","href":"/api-reference/environments/reserve-an-owner-bound-source-upload-prefix-the-uploaded-bytes-with-the-returned-proof-before-saving"},{"title":"Run a command with prepared dependencies and declared credentials, saving declared state with a revision check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/environments/run","href":"/api-reference/environments/run-a-command-with-prepared-dependencies-and-declared-credentials-saving-declared-state-with-a-revision-check"}]},{"group":"secrets","pages":[{"title":"List workspace-shared credential names, kinds and versions; never values","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /secrets","href":"/api-reference/secrets/list-workspace-shared-credential-names-kinds-and-versions;-never-values"},{"title":"Encrypt a workspace credential. Use CLI stdin or the secure chat form; return metadata only. Do not put values in chat, manifests or scripts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /secrets/{name}","href":"/api-reference/secrets/encrypt-a-workspace-credential-use-cli-stdin-or-the-secure-chat-form;-return-metadata-only-do-not-put-values-in-chat-manifests-or-scripts"},{"title":"Revoke a workspace credential for future resolution, optionally checking its version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /secrets/{name}","href":"/api-reference/secrets/revoke-a-workspace-credential-for-future-resolution-optionally-checking-its-version"}]},{"group":"campaigns","pages":[{"title":"Create an idempotent empty campaign draft with the caller's available sender pools. Does not launch or send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/drafts","href":"/api-reference/campaigns/create-an-idempotent-empty-campaign-draft-with-the-callers-available-sender-pools-does-not-launch-or-send"},{"title":"Search people by filters without adding CRM records or campaign recipients. Search credits apply; this is not a free provider preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/audience/search","href":"/api-reference/campaigns/search-people-by-filters-without-adding-crm-records-or-campaign-recipients-search-credits-apply;-this-is-not-a-free-provider-preview"},{"title":"Search and add up to 50 people to an existing campaign. New identities become Leads. Search credits apply; use nextPageToken for another page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/people/search","href":"/api-reference/campaigns/search-and-add-up-to-50-people-to-an-existing-campaign-new-identities-become-leads-search-credits-apply;-use-nextpagetoken-for-another-page"},{"title":"Add up to 300 selected recipients without another search. Chunks writes server-side, deduplicates, applies suppression, and preserves the campaign's launch state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/people/batch","href":"/api-reference/campaigns/add-up-to-300-selected-recipients-without-another-search-chunks-writes-server-side-deduplicates-applies-suppression-and-preserves-the-campaigns-launch-state"},{"title":"Read a campaign's saved signal source, targeting and schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/sources","href":"/api-reference/campaigns/read-a-campaigns-saved-signal-source-targeting-and-schedule"},{"title":"Update source cadence, pause/resume, targeting, signals or terms. Active sources may perform billable future work","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{sequenceId}/sources","href":"/api-reference/campaigns/update-source-cadence-pauseresume-targeting-signals-or-terms-active-sources-may-perform-billable-future-work"},{"title":"Read signal choices, suggested terms and current source configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/sources/signals","href":"/api-reference/campaigns/read-signal-choices-suggested-terms-and-current-source-configuration"},{"title":"Preview a signal source using its current audience. Provider credits may apply; does not enroll people","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/sources/preview","href":"/api-reference/campaigns/preview-a-signal-source-using-its-current-audience-provider-credits-may-apply;-does-not-enroll-people"},{"title":"Run a live campaign's signals now instead of waiting for the schedule (Run now). Provider credits apply; limited to 6 runs an hour","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/sources/run","href":"/api-reference/campaigns/run-a-live-campaigns-signals-now-instead-of-waiting-for-the-schedule-run-now-provider-credits-apply;-limited-to-6-runs-an-hour"},{"title":"Read the Sources tab: each signal's status, last and next run, people found and anything needing attention","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/sources/overview","href":"/api-reference/campaigns/read-the-sources-tab:-each-signals-status-last-and-next-run-people-found-and-anything-needing-attention"},{"title":"List people a signal found who are waiting for approval (manual approval mode)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/sources/pending","href":"/api-reference/campaigns/list-people-a-signal-found-who-are-waiting-for-approval-manual-approval-mode"},{"title":"Approve people waiting for review (they start the sequence) or reject them","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/sources/review","href":"/api-reference/campaigns/approve-people-waiting-for-review-they-start-the-sequence-or-reject-them"},{"title":"Today's queue: who the campaign plans to contact today, warmest first, within the senders' limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/queue","href":"/api-reference/campaigns/todays-queue:-who-the-campaign-plans-to-contact-today-warmest-first-within-the-senders-limits"},{"title":"Read the company profile and suggested campaign audience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/builder/profile","href":"/api-reference/campaigns/read-the-company-profile-and-suggested-campaign-audience"},{"title":"List saved, unfinished campaign drafts that can be resumed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/builder/drafts","href":"/api-reference/campaigns/list-saved-unfinished-campaign-drafts-that-can-be-resumed"},{"title":"Save a signal campaign's audience, signals and terms idempotently. Does not start a build","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/drafts","href":"/api-reference/campaigns/save-a-signal-campaigns-audience-signals-and-terms-idempotently-does-not-start-a-build"},{"title":"Read signal build progress, preview people, messages and errors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/builder/drafts/{draftId}","href":"/api-reference/campaigns/read-signal-build-progress-preview-people-messages-and-errors"},{"title":"Discard a saved draft that has not become a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/builder/drafts/{draftId}","href":"/api-reference/campaigns/discard-a-saved-draft-that-has-not-become-a-campaign"},{"title":"Read every lead a signal build kept (not just the five previewed): person, company, LinkedIn URL and the signal's evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/builder/drafts/{draftId}/leads","href":"/api-reference/campaigns/read-every-lead-a-signal-build-kept-not-just-the-five-previewed:-person-company-linkedin-url-and-the-signals-evidence"},{"title":"Start the same billable signal/audience/message build used by the UI; poll the draft for progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/drafts/{draftId}/build","href":"/api-reference/campaigns/start-the-same-billable-signalaudiencemessage-build-used-by-the-ui;-poll-the-draft-for-progress"},{"title":"Create a campaign from a reviewed signal draft. Does not launch the campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/drafts/{draftId}/create","href":"/api-reference/campaigns/create-a-campaign-from-a-reviewed-signal-draft-does-not-launch-the-campaign"},{"title":"Edit or reset one preview person's opening line before creating the campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/builder/drafts/{draftId}/people/{leadId}/opener","href":"/api-reference/campaigns/edit-or-reset-one-preview-persons-opening-line-before-creating-the-campaign"},{"title":"Read a saved draft's setup (source, name, targeting, signals, terms, lookalike) to resume it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/builder/drafts/{draftId}/setup","href":"/api-reference/campaigns/read-a-saved-drafts-setup-source-name-targeting-signals-terms-lookalike-to-resume-it"},{"title":"Save a draft's Outreach and Review choices: AI or manual steps, the brief, the steps, who sends and when, and auto or manual approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/builder/drafts/{draftId}/outreach","href":"/api-reference/campaigns/save-a-drafts-outreach-and-review-choices:-ai-or-manual-steps-the-brief-the-steps-who-sends-and-when-and-auto-or-manual-approval"},{"title":"Generate the draft's sequence from a brief (goal, problem, tone, channels), as Generate sequence does. AI credits apply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/drafts/{draftId}/sequence","href":"/api-reference/campaigns/generate-the-drafts-sequence-from-a-brief-goal-problem-tone-channels-as-generate-sequence-does-ai-credits-apply"},{"title":"Set up a lookalike from the best lead's LinkedIn URL (role, similar roles, place, industry, similar companies), suggest roles again, or re-scope to a company. Nothing is saved. Provider credits apply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/lookalike","href":"/api-reference/campaigns/set-up-a-lookalike-from-the-best-leads-linkedin-url-role-similar-roles-place-industry-similar-companies-suggest-roles-again-or-re-scope-to-a-company-nothing-is-saved-provider-credits-apply"},{"title":"Suggest market voices (LinkedIn experts) for the campaign's topics, to watch with voice_engagement. AI credits apply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/voices","href":"/api-reference/campaigns/suggest-market-voices-linkedin-experts-for-the-campaigns-topics-to-watch-with-voice_engagement-ai-credits-apply"},{"title":"Turn an audience description into targeting filters. AI credits apply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/autofill","href":"/api-reference/campaigns/turn-an-audience-description-into-targeting-filters-ai-credits-apply"},{"title":"Estimate audience or weekly signal volume using the UI's cached estimator. Provider credits may apply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/builder/estimate","href":"/api-reference/campaigns/estimate-audience-or-weekly-signal-volume-using-the-uis-cached-estimator-provider-credits-may-apply"},{"title":"Discover LinkedIn sender ids, labels, availability and remaining capacity visible to the acting workspace member. Never returns provider credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/accounts/linkedin","href":"/api-reference/campaigns/discover-linkedin-sender-ids-labels-availability-and-remaining-capacity-visible-to-the-acting-workspace-member-never-returns-provider-credentials"},{"title":"Send one LinkedIn message now as the acting member, like the Inbox's Send button: not paced, 1st-degree connections only. Only use for an explicit send request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/linkedin/messages","href":"/api-reference/campaigns/send-one-linkedin-message-now-as-the-acting-member-like-the-inboxs-send-button:-not-paced-1st-degree-connections-only-only-use-for-an-explicit-send-request"},{"title":"Discover the mailboxes the acting workspace member can send campaign email from: ids for emailMailboxAccountIds, status, warm-up state and when it is done, the daily cold-email cap and what is left today. Never returns provider credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/accounts/email","href":"/api-reference/campaigns/discover-the-mailboxes-the-acting-workspace-member-can-send-campaign-email-from:-ids-for-emailmailboxaccountids-status-warm-up-state-and-when-it-is-done-the-daily-cold-email-cap-and-what-is-left-today-never-returns-provider-credentials"},{"title":"List outreach campaigns of every kind on the Campaigns page, each with its kind (archived ones on request)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns","href":"/api-reference/campaigns/list-outreach-campaigns-of-every-kind-on-the-campaigns-page-each-with-its-kind-archived-ones-on-request"},{"title":"Create a draft outreach campaign with email and LinkedIn sender pools and a business-hours send window in the given timezone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns","href":"/api-reference/campaigns/create-a-draft-outreach-campaign-with-email-and-linkedin-sender-pools-and-a-business-hours-send-window-in-the-given-timezone"},{"title":"Copy a campaign into a new draft named \"\u003cname> copy\": the same steps, schedule, sender pools and personalized lines, its lead source paused, and no people. To reach more than 300 people, duplicate and add the next page of the search to the copy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/duplicate","href":"/api-reference/campaigns/copy-a-campaign-into-a-new-draft-named-\"\u003cname>-copy\":-the-same-steps-schedule-sender-pools-and-personalized-lines-its-lead-source-paused-and-no-people-to-reach-more-than-300-people-duplicate-and-add-the-next-page-of-the-search-to-the-copy"},{"title":"Read a campaign: settings, steps, people, their current step and hold, last touches, linked leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}","href":"/api-reference/campaigns/read-a-campaign:-settings-steps-people-their-current-step-and-hold-last-touches-linked-leads"},{"title":"Change a campaign's name, sender pools, send windows, daily email cap, stop-on-reply, start or end. Works until archived; existing conversations keep their assigned sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{sequenceId}","href":"/api-reference/campaigns/change-a-campaigns-name-sender-pools-send-windows-daily-email-cap-stop-on-reply-start-or-end-works-until-archived;-existing-conversations-keep-their-assigned-sender"},{"title":"Campaign funnel: enrolled, contacted, invited, accepted, messaged, replied, opens and clicks, and for a workflow how many people took each If / else and Wait for them to accept path (branchStats)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/analytics","href":"/api-reference/campaigns/campaign-funnel:-enrolled-contacted-invited-accepted-messaged-replied-opens-and-clicks-and-for-a-workflow-how-many-people-took-each-if-else-and-wait-for-them-to-accept-path-branchstats"},{"title":"What the campaign is doing now, what comes next and when, and why it is holding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/live","href":"/api-reference/campaigns/what-the-campaign-is-doing-now-what-comes-next-and-when-and-why-it-is-holding"},{"title":"Where a campaign's people sit in the workspace's lead pipeline right now: each lead Status in order with how many enrolled leads are at it, and how many have no lead or a status outside the pipeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/pipeline","href":"/api-reference/campaigns/where-a-campaigns-people-sit-in-the-workspaces-lead-pipeline-right-now:-each-lead-status-in-order-with-how-many-enrolled-leads-are-at-it-and-how-many-have-no-lead-or-a-status-outside-the-pipeline"},{"title":"Replace every step of a draft campaign (email, wait, LinkedIn visit, connection request, message, post reaction, InMail, If / else, Wait for them to accept). A workflow (stepModel workflow, or steps with key, next, yesNext or noNext) branches: condition and wait_for_connection steps continue on yesNext or noNext, other steps on next; each points at another step's key or end. Steps are checked first: a field the step type would drop, missing text, {TOKEN} single braces or paths that don't hold together are rejected, not saved. Configure sender pools on the campaign; step sender ids are legacy-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/{sequenceId}/steps","href":"/api-reference/campaigns/replace-every-step-of-a-draft-campaign-email-wait-linkedin-visit-connection-request-message-post-reaction-inmail-if-else-wait-for-them-to-accept-a-workflow-stepmodel-workflow-or-steps-with-key-next-yesnext-or-nonext-branches:-condition-and-wait_for_connection-steps-continue-on-yesnext-or-nonext-other-steps-on-next;-each-points-at-another-steps-key-or-end-steps-are-checked-first:-a-field-the-step-type-would-drop-missing-text--single-braces-or-paths-that-dont-hold-together-are-rejected-not-saved-configure-sender-pools-on-the-campaign;-step-sender-ids-are-legacy-only"},{"title":"Edit the text, waits and conditions of a launched (or paused) campaign's steps in place. Each step keeps its id, type and place; pass the stepId and the updatedAt you read, and only the fields you change. A workflow keeps its paths and what each If / else checks (key, next, yesNext, noNext, check, conditionField, conditionOperator); conditionValue and acceptance waits stay editable. Messages already sent or being prepared keep their text; drafts use campaigns.steps.replace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{sequenceId}/steps","href":"/api-reference/campaigns/edit-the-text-waits-and-conditions-of-a-launched-or-paused-campaigns-steps-in-place-each-step-keeps-its-id-type-and-place;-pass-the-stepid-and-the-updatedat-you-read-and-only-the-fields-you-change-a-workflow-keeps-its-paths-and-what-each-if-else-checks-key-next-yesnext-nonext-check-conditionfield-conditionoperator;-conditionvalue-and-acceptance-waits-stay-editable-messages-already-sent-or-being-prepared-keep-their-text;-drafts-use-campaignsstepsreplace"},{"title":"Read a campaign's personalized lines (written for each person): their {{keys}} for steps, instructions and fallbacks, how many people have them, and the cost per person","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/personalization","href":"/api-reference/campaigns/read-a-campaigns-personalized-lines-written-for-each-person:-their--for-steps-instructions-and-fallbacks-how-many-people-have-them-and-the-cost-per-person"},{"title":"Define up to 5 personalized lines (each used as {{key}} in steps) and what you sell. Saving starts writing missing lines for up to 100 people, about 3 cents a person; for more it returns needsConfirm and writes nothing until campaigns.personalization.write is confirmed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/{sequenceId}/personalization","href":"/api-reference/campaigns/define-up-to-5-personalized-lines-each-used-as--in-steps-and-what-you-sell-saving-starts-writing-missing-lines-for-up-to-100-people-about-3-cents-a-person;-for-more-it-returns-needsconfirm-and-writes-nothing-until-campaignspersonalizationwrite-is-confirmed"},{"title":"Turn off a campaign's personalized lines and cancel the ones not yet written. Refused while a step still uses one of the {{keys}}","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/{sequenceId}/personalization","href":"/api-reference/campaigns/turn-off-a-campaigns-personalized-lines-and-cancel-the-ones-not-yet-written-refused-while-a-step-still-uses-one-of-the-"},{"title":"Write personalized lines for the people missing them (mode missing) or rewrite everyone's (mode all). Rewriting everyone or more than 100 people returns needsConfirm and the estimate until called with confirmed: true","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/personalization/write","href":"/api-reference/campaigns/write-personalized-lines-for-the-people-missing-them-mode-missing-or-rewrite-everyones-mode-all-rewriting-everyone-or-more-than-100-people-returns-needsconfirm-and-the-estimate-until-called-with-confirmed:-true"},{"title":"Set one person's personalized line by hand; an empty value undoes the edit. Braces are removed and text past the line's length is cut","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/people/{enrollmentId}/personalization","href":"/api-reference/campaigns/set-one-persons-personalized-line-by-hand;-an-empty-value-undoes-the-edit-braces-are-removed-and-text-past-the-lines-length-is-cut"},{"title":"Write a fresh personalized line for one person: one key, or all of their lines when key is left out. About 3 cents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/people/{enrollmentId}/personalization/rewrite","href":"/api-reference/campaigns/write-a-fresh-personalized-line-for-one-person:-one-key-or-all-of-their-lines-when-key-is-left-out-about-3-cents"},{"title":"Add CRM records (up to 100 ids per call) to a campaign; returns how many were added and why others were skipped","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/people","href":"/api-reference/campaigns/add-crm-records-up-to-100-ids-per-call-to-a-campaign;-returns-how-many-were-added-and-why-others-were-skipped"},{"title":"Add one person by email and/or LinkedIn profile URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/person","href":"/api-reference/campaigns/add-one-person-by-email-andor-linkedin-profile-url"},{"title":"Show the message one person gets at one email or LinkedIn step, with their fields and personalized lines filled in: subject, body, sender, recipient, merge fields still missing, warnings, and why the step would be skipped. Nothing is sent, prepared or charged","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/preview","href":"/api-reference/campaigns/show-the-message-one-person-gets-at-one-email-or-linkedin-step-with-their-fields-and-personalized-lines-filled-in:-subject-body-sender-recipient-merge-fields-still-missing-warnings-and-why-the-step-would-be-skipped-nothing-is-sent-prepared-or-charged"},{"title":"Launch readiness without launching: blockers grouped by problem, warnings, and the fingerprint `launch` requires","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/launch","href":"/api-reference/campaigns/launch-readiness-without-launching:-blockers-grouped-by-problem-warnings-and-the-fingerprint-`launch`-requires"},{"title":"Launch a ready draft. Pass the fingerprint from the preview and acknowledge the LinkedIn notice when LinkedIn steps exist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/launch","href":"/api-reference/campaigns/launch-a-ready-draft-pass-the-fingerprint-from-the-preview-and-acknowledge-the-linkedin-notice-when-linkedin-steps-exist"},{"title":"Pause an active campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/pause","href":"/api-reference/campaigns/pause-an-active-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/resume","href":"/api-reference/campaigns/resume-a-paused-campaign"},{"title":"Archive a campaign and stop everyone still in flight. This is the app's Delete: campaigns are never erased, and their people, leads and activity stay","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/archive","href":"/api-reference/campaigns/archive-a-campaign-and-stop-everyone-still-in-flight-this-is-the-apps-delete:-campaigns-are-never-erased-and-their-people-leads-and-activity-stay"},{"title":"The campaign's activity log, newest first (sent, accepted, replied, skipped, failed, paused, stopped)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{sequenceId}/events","href":"/api-reference/campaigns/the-campaigns-activity-log-newest-first-sent-accepted-replied-skipped-failed-paused-stopped"},{"title":"Stop one person: nothing more is sent to them from this campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/people/{enrollmentId}/stop","href":"/api-reference/campaigns/stop-one-person:-nothing-more-is-sent-to-them-from-this-campaign"},{"title":"Resume one paused person in an active campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/people/{enrollmentId}/resume","href":"/api-reference/campaigns/resume-one-paused-person-in-an-active-campaign"},{"title":"Give a person in a draft campaign a new or corrected email address; their linked CRM record gets it too. Only before launch; another person in the campaign can't share it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/people/{enrollmentId}/email","href":"/api-reference/campaigns/give-a-person-in-a-draft-campaign-a-new-or-corrected-email-address;-their-linked-crm-record-gets-it-too-only-before-launch;-another-person-in-the-campaign-cant-share-it"},{"title":"Give a person in a draft campaign a new or corrected LinkedIn profile URL; their linked CRM record gets it too. Only before launch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/people/{enrollmentId}/linkedin","href":"/api-reference/campaigns/give-a-person-in-a-draft-campaign-a-new-or-corrected-linkedin-profile-url;-their-linked-crm-record-gets-it-too-only-before-launch"},{"title":"Fill or fix one {{merge field}} for a person in a draft campaign, e.g. a missing Company that blocks launch; a matching column on their CRM record is updated too. Only before launch; written personalized lines are not merge fields and can't be set here","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/people/{enrollmentId}/fields","href":"/api-reference/campaigns/fill-or-fix-one--for-a-person-in-a-draft-campaign-eg-a-missing-company-that-blocks-launch;-a-matching-column-on-their-crm-record-is-updated-too-only-before-launch;-written-personalized-lines-are-not-merge-fields-and-cant-be-set-here"},{"title":"Resume every paused person in an active campaign at once, e.g. after a sending account is reconnected. Returns how many were resumed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/people/resume","href":"/api-reference/campaigns/resume-every-paused-person-in-an-active-campaign-at-once-eg-after-a-sending-account-is-reconnected-returns-how-many-were-resumed"},{"title":"Fill each unfinished person's empty email, LinkedIn URL, name and merge fields from their linked CRM record, e.g. after enriching the records. Never overwrites a value the campaign already has; returns how many people changed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{sequenceId}/people/sync","href":"/api-reference/campaigns/fill-each-unfinished-persons-empty-email-linkedin-url-name-and-merge-fields-from-their-linked-crm-record-eg-after-enriching-the-records-never-overwrites-a-value-the-campaign-already-has;-returns-how-many-people-changed"},{"title":"The campaigns a CRM record (a person or a lead) is in, newest first, with the person's status in each and the accounts that send to them","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/by-record/{entryId}","href":"/api-reference/campaigns/the-campaigns-a-crm-record-a-person-or-a-lead-is-in-newest-first-with-the-persons-status-in-each-and-the-accounts-that-send-to-them"},{"title":"Everything a campaign did for one person, step by step: what was sent (subject and text), whether it was opened or clicked, what was skipped and why, waits, failures and retries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/people/{enrollmentId}/timeline","href":"/api-reference/campaigns/everything-a-campaign-did-for-one-person-step-by-step:-what-was-sent-subject-and-text-whether-it-was-opened-or-clicked-what-was-skipped-and-why-waits-failures-and-retries"},{"title":"Remove a person who was never contacted from a draft campaign. Frees their place in the 300-person cap and keeps the draft launchable; stop anyone already contacted instead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/people/{enrollmentId}","href":"/api-reference/campaigns/remove-a-person-who-was-never-contacted-from-a-draft-campaign-frees-their-place-in-the-300-person-cap-and-keeps-the-draft-launchable;-stop-anyone-already-contacted-instead"}]},{"group":"meta","pages":[{"title":"List operations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /commands","href":"/api-reference/meta/list-operations"}]},{"group":"auth","pages":[{"title":"Create sign-in request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signin-requests","href":"/api-reference/auth/create-sign-in-request"},{"title":"Poll sign-in request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/signin-requests/{requestId}/poll","href":"/api-reference/auth/poll-sign-in-request"},{"title":"Start email OTP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/otp/start","href":"/api-reference/auth/start-email-otp"},{"title":"Verify email OTP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/otp/verify","href":"/api-reference/auth/verify-email-otp"},{"title":"Finalize OTP session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/otp/finalize","href":"/api-reference/auth/finalize-otp-session"}]},{"group":"local","pages":[{"title":"List local sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /local/sessions","href":"/api-reference/local/list-local-sessions"},{"title":"Use local session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/sessions/use","href":"/api-reference/local/use-local-session"},{"title":"Remove local sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/logout","href":"/api-reference/local/remove-local-sessions"},{"title":"Configure CLI backend","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/backend","href":"/api-reference/local/configure-cli-backend"},{"title":"Import CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/crm/import","href":"/api-reference/local/import-csv"},{"title":"Export CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/crm/export","href":"/api-reference/local/export-csv"},{"title":"Import calls from a local CSV/JSONL: meeting fields plus transcript, action items and attendees per row","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/meetings/import","href":"/api-reference/local/import-calls-from-a-local-csvjsonl:-meeting-fields-plus-transcript-action-items-and-attendees-per-row"},{"title":"File sync daemon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/fs","href":"/api-reference/local/file-sync-daemon"}]},{"group":"workspace","pages":[{"title":"Read selected scoped workspace documents and a compact context index without writes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /context/sections","href":"/api-reference/workspace/read-selected-scoped-workspace-documents-and-a-compact-context-index-without-writes"},{"title":"Workspace context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /context","href":"/api-reference/workspace/workspace-context"},{"title":"Workspace instructions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /context/instructions","href":"/api-reference/workspace/workspace-instructions"},{"title":"Workspace status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /status","href":"/api-reference/workspace/workspace-status"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/workspace/list-agents"},{"title":"List artifacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /artifacts","href":"/api-reference/workspace/list-artifacts"},{"title":"Suggested work","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /suggested-work","href":"/api-reference/workspace/suggested-work"},{"title":"Update standing workspace rules; credentials belong in secrets and runnable setup in environments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /context/rules","href":"/api-reference/workspace/update-standing-workspace-rules;-credentials-belong-in-secrets-and-runnable-setup-in-environments"}]},{"group":"lists","pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists","href":"/api-reference/lists/list-lists"},{"title":"Save list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists","href":"/api-reference/lists/save-list"},{"title":"Read saved rows with current enrichment results and original indices; cursor-paged, without repeating a search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/{artifactId}/rows","href":"/api-reference/lists/read-saved-rows-with-current-enrichment-results-and-original-indices;-cursor-paged-without-repeating-a-search"},{"title":"Buy contact details for 1–100 saved profiles and save them to the list. Skips fields already found, looked up empty, or in flight. Requires a signed-in member or their personal agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{artifactId}/enrich","href":"/api-reference/lists/buy-contact-details-for-1–100-saved-profiles-and-save-them-to-the-list-skips-fields-already-found-looked-up-empty-or-in-flight-requires-a-signed-in-member-or-their-personal-agent"},{"title":"Explicitly import selected saved profiles, optionally filtered by enrichment, with a configured Lead status. Reuses CRM records; never sends outreach or triggers conversion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{artifactId}/import","href":"/api-reference/lists/explicitly-import-selected-saved-profiles-optionally-filtered-by-enrichment-with-a-configured-lead-status-reuses-crm-records;-never-sends-outreach-or-triggers-conversion"},{"title":"Get list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/{artifactId}","href":"/api-reference/lists/get-list"},{"title":"Delete list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /lists/{artifactId}","href":"/api-reference/lists/delete-list"},{"title":"Update list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /lists/{artifactId}","href":"/api-reference/lists/update-list"},{"title":"Rename list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{artifactId}/rename","href":"/api-reference/lists/rename-list"},{"title":"Read durable enrichment activity (legacy review metadata remains readable). Use lists rows for current saved profiles and contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/{artifactId}/reviews","href":"/api-reference/lists/read-durable-enrichment-activity-legacy-review-metadata-remains-readable-use-lists-rows-for-current-saved-profiles-and-contacts"},{"title":"Suggest ICP fit for one profile. Never changes a human review decision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{artifactId}/assess","href":"/api-reference/lists/suggest-icp-fit-for-one-profile-never-changes-a-human-review-decision"}]},{"group":"memory","pages":[{"title":"Search memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /memory/search","href":"/api-reference/memory/search-memory"},{"title":"Save memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /memory","href":"/api-reference/memory/save-memory"}]},{"group":"billing","pages":[{"title":"Billing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/status","href":"/api-reference/billing/billing-status"},{"title":"Top up credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/topup","href":"/api-reference/billing/top-up-credits"},{"title":"Upgrade workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/upgrade","href":"/api-reference/billing/upgrade-workspace"}]},{"group":"chat","pages":[{"title":"List threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chat/threads","href":"/api-reference/chat/list-threads"},{"title":"New chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chat/threads","href":"/api-reference/chat/new-chat"},{"title":"Delete threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /chat/threads","href":"/api-reference/chat/delete-threads"},{"title":"Rename threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /chat/threads","href":"/api-reference/chat/rename-threads"},{"title":"Search chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chat/search","href":"/api-reference/chat/search-chats"},{"title":"Read thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chat/threads/{threadId}","href":"/api-reference/chat/read-thread"},{"title":"Thread tree","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chat/tree","href":"/api-reference/chat/thread-tree"},{"title":"Send message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chat/threads/{threadId}/messages","href":"/api-reference/chat/send-message"},{"title":"Follow stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chat/threads/{threadId}/stream","href":"/api-reference/chat/follow-stream"}]},{"group":"crm","pages":[{"title":"List objects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects","href":"/api-reference/crm/list-objects"},{"title":"Create object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects","href":"/api-reference/crm/create-object"},{"title":"List names, display labels, visibility and workspace counts without internal state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/catalog/objects","href":"/api-reference/crm/list-names-display-labels-visibility-and-workspace-counts-without-internal-state"},{"title":"Get object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{name}","href":"/api-reference/crm/get-object"},{"title":"Delete object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{name}","href":"/api-reference/crm/delete-object"},{"title":"Update object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{name}","href":"/api-reference/crm/update-object"},{"title":"Rename object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{from}/rename","href":"/api-reference/crm/rename-object"},{"title":"Hide a CRM object's workspace sidebar row for the whole workspace. Not a delete — the table keeps working. Admin-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{name}/archive","href":"/api-reference/crm/hide-a-crm-objects-workspace-sidebar-row-for-the-whole-workspace-not-a-delete-—-the-table-keeps-working-admin-only"},{"title":"Restore a CRM object's workspace sidebar row. Admin-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{name}/unarchive","href":"/api-reference/crm/restore-a-crm-objects-workspace-sidebar-row-admin-only"},{"title":"List the saved views on a CRM object (plus the active view)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/views","href":"/api-reference/crm/list-the-saved-views-on-a-crm-object-plus-the-active-view"},{"title":"Create a saved view (named filters/sort/columns combo) on a CRM object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/views","href":"/api-reference/crm/create-a-saved-view-named-filterssortcolumns-combo-on-a-crm-object"},{"title":"Get one saved view's definition by name","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/views/{viewName}","href":"/api-reference/crm/get-one-saved-views-definition-by-name"},{"title":"Delete a saved view by name (idempotent)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{objectName}/views/{viewName}","href":"/api-reference/crm/delete-a-saved-view-by-name-idempotent"},{"title":"Replace a saved view's definition (upsert by name)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{objectName}/views/{viewName}","href":"/api-reference/crm/replace-a-saved-views-definition-upsert-by-name"},{"title":"Materialize a saved view's rows (applies its filters/sort/pins), paginated","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/views/{viewName}/entries","href":"/api-reference/crm/materialize-a-saved-views-rows-applies-its-filterssortpins-paginated"},{"title":"Rename view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/views/{viewName}/rename","href":"/api-reference/crm/rename-view"},{"title":"Move a pinned view's sidebar row into the Archived flyout. Admin-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/views/{viewName}/archive","href":"/api-reference/crm/move-a-pinned-views-sidebar-row-into-the-archived-flyout-admin-only"},{"title":"Restore a view's sidebar row (re-asserts its pin). Admin-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/views/{viewName}/unarchive","href":"/api-reference/crm/restore-a-views-sidebar-row-re-asserts-its-pin-admin-only"},{"title":"Describe the workspace sidebar: Library rows in tree order (with their groups), the home-level Pinned strip, what is hidden and why, and whether the caller is an admin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/sidebar","href":"/api-reference/crm/describe-the-workspace-sidebar:-library-rows-in-tree-order-with-their-groups-the-home-level-pinned-strip-what-is-hidden-and-why-and-whether-the-caller-is-an-admin"},{"title":"Reposition one Library row (or group) among the Library's top-level slots. Does not add a home-level Pinned tab. Workspace-shared; admin-only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/move","href":"/api-reference/crm/reposition-one-library-row-or-group-among-the-librarys-top-level-slots-does-not-add-a-home-level-pinned-tab-workspace-shared;-admin-only"},{"title":"Create a named sidebar group (e.g. \"Hiring\") in the workspace-shared Library. Open to any member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/groups","href":"/api-reference/crm/create-a-named-sidebar-group-eg-\"hiring\"-in-the-workspace-shared-library-open-to-any-member"},{"title":"Rename a sidebar group. Open to any member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/groups/rename","href":"/api-reference/crm/rename-a-sidebar-group-open-to-any-member"},{"title":"Dissolve a sidebar group; its rows return to the top level in its slot. Open to any member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/groups/delete","href":"/api-reference/crm/dissolve-a-sidebar-group;-its-rows-return-to-the-top-level-in-its-slot-open-to-any-member"},{"title":"Move a sidebar row into a group (groupId set) or back to the top level (groupId null). Open to any member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/groups/move","href":"/api-reference/crm/move-a-sidebar-row-into-a-group-groupid-set-or-back-to-the-top-level-groupid-null-open-to-any-member"},{"title":"Pin (pinned true) or unpin a Library row — or a whole group — on the home-level Pinned shortcut strip (the \"tab on the left\"). Does not move the row inside Library. Workspace-shared; open to any member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sidebar/pins","href":"/api-reference/crm/pin-pinned-true-or-unpin-a-library-row-—-or-a-whole-group-—-on-the-home-level-pinned-shortcut-strip-the-\"tab-on-the-left\"-does-not-move-the-row-inside-library-workspace-shared;-open-to-any-member"},{"title":"List fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/fields","href":"/api-reference/crm/list-fields"},{"title":"Create field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields","href":"/api-reference/crm/create-field"},{"title":"List field names, types and effective constraints without indexing or enrichment internals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/catalog/objects/{objectName}/fields","href":"/api-reference/crm/list-field-names-types-and-effective-constraints-without-indexing-or-enrichment-internals"},{"title":"Delete field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{objectName}/fields/{fieldName}","href":"/api-reference/crm/delete-field"},{"title":"Update field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{objectName}/fields/{fieldName}","href":"/api-reference/crm/update-field"},{"title":"Reorder fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields/reorder","href":"/api-reference/crm/reorder-fields"},{"title":"Reorder enum values","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields/{fieldName}/enum/reorder","href":"/api-reference/crm/reorder-enum-values"},{"title":"Add enum value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields/{fieldName}/enum","href":"/api-reference/crm/add-enum-value"},{"title":"Remove enum value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{objectName}/fields/{fieldName}/enum/{value}","href":"/api-reference/crm/remove-enum-value"},{"title":"Rename enum value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields/{fieldName}/enum/{oldValue}/rename","href":"/api-reference/crm/rename-enum-value"},{"title":"Set enum color","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/fields/{fieldName}/enum/{value}/color","href":"/api-reference/crm/set-enum-color"},{"title":"List entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries","href":"/api-reference/crm/list-entries"},{"title":"Create entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries","href":"/api-reference/crm/create-entry"},{"title":"Get entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}","href":"/api-reference/crm/get-entry"},{"title":"Delete entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{objectName}/entries/{entryId}","href":"/api-reference/crm/delete-entry"},{"title":"Update entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{objectName}/entries/{entryId}","href":"/api-reference/crm/update-entry"},{"title":"Has Dench read this record's email history? One row per address per mailbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/sync-history","href":"/api-reference/crm/has-dench-read-this-records-email-history?-one-row-per-address-per-mailbox"},{"title":"Queue a full, paged pull of the record's email history from every connected mailbox; the ledger fills as pages land","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/sync-history","href":"/api-reference/crm/queue-a-full-paged-pull-of-the-records-email-history-from-every-connected-mailbox;-the-ledger-fills-as-pages-land"},{"title":"Status of the account's research dossier — the delimited `dench:dossier` section Dench keeps in the record's Notes: status, when it was written, how many dated updates followed, the last error","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/entries/{entryId}/dossier","href":"/api-reference/crm/status-of-the-accounts-research-dossier-—-the-delimited-`dench:dossier`-section-dench-keeps-in-the-records-notes:-status-when-it-was-written-how-many-dated-updates-followed-the-last-error"},{"title":"Research the account again and append a fresh dossier section to its Notes (needs a Website / Domain on the record)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/entries/{entryId}/dossier/regenerate","href":"/api-reference/crm/research-the-account-again-and-append-a-fresh-dossier-section-to-its-notes-needs-a-website-domain-on-the-record"},{"title":"Whether the caller hides their own emails / messages with this record from the workspace (directly, or through its account), and whether they own a connection the toggle applies to","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/entries/{entryId}/privacy","href":"/api-reference/crm/whether-the-caller-hides-their-own-emails-messages-with-this-record-from-the-workspace-directly-or-through-its-account-and-whether-they-own-a-connection-the-toggle-applies-to"},{"title":"Hide (`hidden: true`) or show the caller's own emails / messages with this record to the workspace. An account covers every contact and opportunity linked to it; existing ledger rows are restamped and the shared Brief regenerates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/entries/{entryId}/privacy","href":"/api-reference/crm/hide-`hidden:-true`-or-show-the-callers-own-emails-messages-with-this-record-to-the-workspace-an-account-covers-every-contact-and-opportunity-linked-to-it;-existing-ledger-rows-are-restamped-and-the-shared-brief-regenerates"},{"title":"Find ranked warm-intro paths from your own email, meetings and LinkedIn connections into a company, domain, person or CRM record id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/warm-intros","href":"/api-reference/crm/find-ranked-warm-intro-paths-from-your-own-email-meetings-and-linkedin-connections-into-a-company-domain-person-or-crm-record-id"},{"title":"List account-detection verdicts — why a domain (or personal address) did or did not become an account: verdict, counterparty type, probabilities, evidence threads, the rows created. `kind` picks the creator: `detections` (email + sweep), `linkedin` (the LinkedIn resolver's rows) or `all` (default). Newest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/detections","href":"/api-reference/crm/list-account-detection-verdicts-—-why-a-domain-or-personal-address-did-or-did-not-become-an-account:-verdict-counterparty-type-probabilities-evidence-threads-the-rows-created-`kind`-picks-the-creator:-`detections`-email-+-sweep-`linkedin`-the-linkedin-resolvers-rows-or-`all`-default-newest-first"},{"title":"Undo what the ingestion jobs created since a timestamp (admin): `kind` = `detections` (accounts + contacts from the email detector and the sweep), `linkedin` (the LinkedIn resolver's contacts + accounts; their conversations are unlinked and parked), `email-tasks` (auto-created tasks and cases) or `all` (default). Deletes only rows no human has touched and marks the verdicts / decisions rolled_back so they are never re-created. `dryRun` lists what would go; per-kind counts in `kinds`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/detections/undo","href":"/api-reference/crm/undo-what-the-ingestion-jobs-created-since-a-timestamp-admin:-`kind`-=-`detections`-accounts-+-contacts-from-the-email-detector-and-the-sweep-`linkedin`-the-linkedin-resolvers-contacts-+-accounts;-their-conversations-are-unlinked-and-parked-`email-tasks`-auto-created-tasks-and-cases-or-`all`-default-deletes-only-rows-no-human-has-touched-and-marks-the-verdicts-decisions-rolled_back-so-they-are-never-re-created-`dryrun`-lists-what-would-go;-per-kind-counts-in-`kinds`"},{"title":"List a CRM entry's audit history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/history","href":"/api-reference/crm/list-a-crm-entrys-audit-history"},{"title":"List a CRM entry's activity ledger (comments, notes, field changes, emails, meetings, Slack, LinkedIn) in one timeline, newest first by default","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/activity","href":"/api-reference/crm/list-a-crm-entrys-activity-ledger-comments-notes-field-changes-emails-meetings-slack-linkedin-in-one-timeline-newest-first-by-default"},{"title":"The record's generated Brief: health, who owes the next move, open threads, commitments, risks, next step. Read this before the ledger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/brief","href":"/api-reference/crm/the-records-generated-brief:-health-who-owes-the-next-move-open-threads-commitments-risks-next-step-read-this-before-the-ledger"},{"title":"Read-only source diagnostics: accessible evidence, association reasons, last Brief source manifest, generation queue, and your mailbox delivery health. Bounded, cursor-paged snapshot; does not certify complete history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/context","href":"/api-reference/crm/read-only-source-diagnostics:-accessible-evidence-association-reasons-last-brief-source-manifest-generation-queue-and-your-mailbox-delivery-health-bounded-cursor-paged-snapshot;-does-not-certify-complete-history"},{"title":"Rebuild a record's Brief from the current timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/brief/regenerate","href":"/api-reference/crm/rebuild-a-records-brief-from-the-current-timeline"},{"title":"Bounded per-source counts of a CRM entry's activity ledger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/activity/count","href":"/api-reference/crm/bounded-per-source-counts-of-a-crm-entrys-activity-ledger"},{"title":"List a CRM entry's notes (titled, document-style comments), newest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/notes","href":"/api-reference/crm/list-a-crm-entrys-notes-titled-document-style-comments-newest-first"},{"title":"Add a titled note to a CRM entry's activity timeline (markdown body). Research goes here, never into the Notes document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/notes","href":"/api-reference/crm/add-a-titled-note-to-a-crm-entrys-activity-timeline-markdown-body-research-goes-here-never-into-the-notes-document"},{"title":"List comments on a CRM entry (roots newest first, with preview replies)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/comments","href":"/api-reference/crm/list-comments-on-a-crm-entry-roots-newest-first-with-preview-replies"},{"title":"Comment on a CRM entry (markdown). Mention members with [@Name](/?member=\u003cuserId>); mention Dench with [@Dench](/?member=dench) or mentionDench","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/comments","href":"/api-reference/crm/comment-on-a-crm-entry-markdown-mention-members-with-[@name]?member=\u003cuserid>;-mention-dench-with-[@dench]?member=dench-or-mentiondench"},{"title":"List every reply under a root comment, oldest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/comments/{commentId}/replies","href":"/api-reference/crm/list-every-reply-under-a-root-comment-oldest-first"},{"title":"Get one comment with its entry label","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/comments/{commentId}","href":"/api-reference/crm/get-one-comment-with-its-entry-label"},{"title":"Delete a comment (kept as a tombstone when it has replies)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/comments/{commentId}","href":"/api-reference/crm/delete-a-comment-kept-as-a-tombstone-when-it-has-replies"},{"title":"Edit a comment you wrote","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/comments/{commentId}","href":"/api-reference/crm/edit-a-comment-you-wrote"},{"title":"Toggle an emoji reaction on a comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/comments/{commentId}/reactions/{emoji}","href":"/api-reference/crm/toggle-an-emoji-reaction-on-a-comment"},{"title":"Whether you follow a CRM entry's activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/watch","href":"/api-reference/crm/whether-you-follow-a-crm-entrys-activity"},{"title":"Follow or unfollow a CRM entry's activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/objects/{objectName}/entries/{entryId}/watch","href":"/api-reference/crm/follow-or-unfollow-a-crm-entrys-activity"},{"title":"Page assigned tasks in priority order (or completed tasks by recency)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/assigned/page","href":"/api-reference/crm/page-assigned-tasks-in-priority-order-or-completed-tasks-by-recency"},{"title":"Page all tasks linked to a record, including subtasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/tasks/page","href":"/api-reference/crm/page-all-tasks-linked-to-a-record-including-subtasks"},{"title":"Start or resume preparation of exact task ordering and progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/prepare","href":"/api-reference/crm/start-or-resume-preparation-of-exact-task-ordering-and-progress"},{"title":"Your open tasks (plus ones completed today)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/tasks/mine","href":"/api-reference/crm/your-open-tasks-plus-ones-completed-today"},{"title":"Tasks linked to a CRM entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/tasks","href":"/api-reference/crm/tasks-linked-to-a-crm-entry"},{"title":"Create a task linked to a CRM entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/tasks","href":"/api-reference/crm/create-a-task-linked-to-a-crm-entry"},{"title":"Mark a task done","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/complete","href":"/api-reference/crm/mark-a-task-done"},{"title":"Reopen a completed task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/reopen","href":"/api-reference/crm/reopen-a-completed-task"},{"title":"Set or clear a task's priority","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/tasks/{entryId}/priority","href":"/api-reference/crm/set-or-clear-a-tasks-priority"},{"title":"A task's subtasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/tasks/{entryId}/subtasks","href":"/api-reference/crm/a-tasks-subtasks"},{"title":"Create a subtask under a task (inherits the parent's record relations)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/subtasks","href":"/api-reference/crm/create-a-subtask-under-a-task-inherits-the-parents-record-relations"},{"title":"Nest a task under a parent, or promote it (parentEntryId: null)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/tasks/{entryId}/parent","href":"/api-reference/crm/nest-a-task-under-a-parent-or-promote-it-parententryid:-null"},{"title":"Delete a task and its subtasks, or keep them as tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/tasks/{entryId}","href":"/api-reference/crm/delete-a-task-and-its-subtasks-or-keep-them-as-tasks"},{"title":"How a task repeats (rule, RRULE, trigger, ends, next due)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/tasks/{entryId}/repeat","href":"/api-reference/crm/how-a-task-repeats-rule-rrule-trigger-ends-next-due"},{"title":"Make a task repeat, or change how it repeats (JSON rule or RRULE). An undated task gets its due date anchored on the first matching day from today","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/tasks/{entryId}/repeat","href":"/api-reference/crm/make-a-task-repeat-or-change-how-it-repeats-json-rule-or-rrule-an-undated-task-gets-its-due-date-anchored-on-the-first-matching-day-from-today"},{"title":"Stop a task repeating (past occurrences are kept)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/tasks/{entryId}/repeat","href":"/api-reference/crm/stop-a-task-repeating-past-occurrences-are-kept"},{"title":"Skip the current occurrence: the next one is created now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/repeat/skip","href":"/api-reference/crm/skip-the-current-occurrence:-the-next-one-is-created-now"},{"title":"Pause a repeating task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/repeat/pause","href":"/api-reference/crm/pause-a-repeating-task"},{"title":"Resume a paused repeating task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/tasks/{entryId}/repeat/resume","href":"/api-reference/crm/resume-a-paused-repeating-task"},{"title":"Every repeating-task series in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/tasks/series","href":"/api-reference/crm/every-repeating-task-series-in-the-workspace"},{"title":"Every occurrence (task) of one series","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/tasks/series/{seriesId}/occurrences","href":"/api-reference/crm/every-occurrence-task-of-one-series"},{"title":"Create many entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/batch","href":"/api-reference/crm/create-many-entries"},{"title":"Update many entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{objectName}/entries/batch","href":"/api-reference/crm/update-many-entries"},{"title":"Bulk delete entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/delete","href":"/api-reference/crm/bulk-delete-entries"},{"title":"Get cell","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/entries/{entryId}/fields/{fieldName}","href":"/api-reference/crm/get-cell"},{"title":"Set cell","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/objects/{objectName}/entries/{entryId}/fields/{fieldName}","href":"/api-reference/crm/set-cell"},{"title":"Set many cells","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/cells/batch","href":"/api-reference/crm/set-many-cells"},{"title":"Append cell","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/entries/{entryId}/fields/{fieldName}/append","href":"/api-reference/crm/append-cell"},{"title":"Query entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/query","href":"/api-reference/crm/query-entries"},{"title":"Scan CRM entries with a resumable cursor. Empty filtered pages can have more results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/query/page","href":"/api-reference/crm/scan-crm-entries-with-a-resumable-cursor-empty-filtered-pages-can-have-more-results"},{"title":"SQL query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/sql","href":"/api-reference/crm/sql-query"},{"title":"Aggregate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/aggregate","href":"/api-reference/crm/aggregate"},{"title":"Search entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/search","href":"/api-reference/crm/search-entries"},{"title":"Search bounded pages of readable CRM entries, optionally projecting cells. Always follow continueCursor until isDone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/search/page","href":"/api-reference/crm/search-bounded-pages-of-readable-crm-entries-optionally-projecting-cells-always-follow-continuecursor-until-isdone"},{"title":"List statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/statuses","href":"/api-reference/crm/list-statuses"},{"title":"Set statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/objects/{objectName}/statuses","href":"/api-reference/crm/set-statuses"},{"title":"Batch operations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/batch","href":"/api-reference/crm/batch-operations"},{"title":"Begin transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/transactions","href":"/api-reference/crm/begin-transaction"},{"title":"Add operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/transactions/{txnId}/operations","href":"/api-reference/crm/add-operation"},{"title":"Commit transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/transactions/{txnId}/commit","href":"/api-reference/crm/commit-transaction"},{"title":"Abort transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/transactions/{txnId}/abort","href":"/api-reference/crm/abort-transaction"},{"title":"Inspect transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/transactions/{txnId}","href":"/api-reference/crm/inspect-transaction"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/docs","href":"/api-reference/crm/list-documents"},{"title":"Create document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/docs","href":"/api-reference/crm/create-document"},{"title":"Link document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/docs/link","href":"/api-reference/crm/link-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/docs/{documentId}","href":"/api-reference/crm/delete-document"},{"title":"List actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/actions","href":"/api-reference/crm/list-actions"},{"title":"Create or upsert an action button on a named action column (fieldName is the column header; a column can hold multiple buttons — reuse fieldName to add more)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/actions","href":"/api-reference/crm/create-or-upsert-an-action-button-on-a-named-action-column-fieldname-is-the-column-header;-a-column-can-hold-multiple-buttons-—-reuse-fieldname-to-add-more"},{"title":"Delete an action button from a CRM field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/actions/{actionId}","href":"/api-reference/crm/delete-an-action-button-from-a-crm-field"},{"title":"Update an action button on a CRM field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/actions/{actionId}","href":"/api-reference/crm/update-an-action-button-on-a-crm-field"},{"title":"Run action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/actions/{actionId}/runs","href":"/api-reference/crm/run-action"},{"title":"List members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members","href":"/api-reference/crm/list-members"},{"title":"Generate report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/reports","href":"/api-reference/crm/generate-report"},{"title":"Read an object's analytics dashboard: panels, field roles, the strip's collapsed flag, the named view's own dashboard (if any), and the fields panels may bucket on (synthetic $createdAt / $location last)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/objects/{objectName}/analytics","href":"/api-reference/crm/read-an-objects-analytics-dashboard:-panels-field-roles-the-strips-collapsed-flag-the-named-views-own-dashboard-if-any-and-the-fields-panels-may-bucket-on-synthetic-$createdat-$location-last"},{"title":"Compute chart-ready results (buckets / series / values) for the stored dashboard, a subset of its panels, or ad-hoc panel definitions — optionally scoped to a saved view, a period preset (with the previous interval as previousValue) and extra filters. Same query the strip renders from","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/compute","href":"/api-reference/crm/compute-chart-ready-results-buckets-series-values-for-the-stored-dashboard-a-subset-of-its-panels-or-ad-hoc-panel-definitions-—-optionally-scoped-to-a-saved-view-a-period-preset-with-the-previous-interval-as-previousvalue-and-extra-filters-same-query-the-strip-renders-from"},{"title":"Create or update one panel (upsert by id). With viewName the write lands on that saved view's own dashboard, forking a copy if it was still inheriting the object's","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/objects/{objectName}/analytics/panels/{panelId}","href":"/api-reference/crm/create-or-update-one-panel-upsert-by-id-with-viewname-the-write-lands-on-that-saved-views-own-dashboard-forking-a-copy-if-it-was-still-inheriting-the-objects"},{"title":"Delete one panel (idempotent). Template panels are tombstoned so a re-install never resurrects them","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /crm/objects/{objectName}/analytics/panels/{panelId}","href":"/api-reference/crm/delete-one-panel-idempotent-template-panels-are-tombstoned-so-a-re-install-never-resurrects-them"},{"title":"Edit part of one stored panel: only the keys in `patch` change (title, type, metric, metricField, groupBy, dateField, dateBucket, filters, derived, span, hidden, sortOrder); null clears an optional key. What the card's ⋮ menu writes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/objects/{objectName}/analytics/panels/{panelId}","href":"/api-reference/crm/edit-part-of-one-stored-panel:-only-the-keys-in-`patch`-change-title-type-metric-metricfield-groupby-datefield-datebucket-filters-derived-span-hidden-sortorder;-null-clears-an-optional-key-what-the-cards-⋮-menu-writes"},{"title":"Take a chart off the strip above the table (hidden: true). It stays in the full analytics view, counted by the strip's “+N more”","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/panels/{panelId}/hide","href":"/api-reference/crm/take-a-chart-off-the-strip-above-the-table-hidden:-true-it-stays-in-the-full-analytics-view-counted-by-the-strips-“+n-more”"},{"title":"Bring a hidden chart back onto the strip (hidden: false)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/panels/{panelId}/show","href":"/api-reference/crm/bring-a-hidden-chart-back-onto-the-strip-hidden:-false"},{"title":"Set a card's width on the 6-track dashboard grid: span 2 (third), 3 (half), 4 (two thirds), 6 (full), or null for the chart kind's default","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/panels/{panelId}/resize","href":"/api-reference/crm/set-a-cards-width-on-the-6-track-dashboard-grid:-span-2-third-3-half-4-two-thirds-6-full-or-null-for-the-chart-kinds-default"},{"title":"Persist the full panel order. panelIds must name every stored panel of the targeted dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/reorder","href":"/api-reference/crm/persist-the-full-panel-order-panelids-must-name-every-stored-panel-of-the-targeted-dashboard"},{"title":"Set the object's analytics setup — the field roles shared by every chart and view (amount, stage, won/lost/converted values, stageProbabilities, closeDate, recurrence, owner, location). Replaces the mapping; with merge: true only the keys given change and null clears one","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /crm/objects/{objectName}/analytics/roles","href":"/api-reference/crm/set-the-objects-analytics-setup-—-the-field-roles-shared-by-every-chart-and-view-amount-stage-wonlostconverted-values-stageprobabilities-closedate-recurrence-owner-location-replaces-the-mapping;-with-merge:-true-only-the-keys-given-change-and-null-clears-one"},{"title":"Collapse the analytics strip above the object's table (team-shared, like saved views)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/collapse","href":"/api-reference/crm/collapse-the-analytics-strip-above-the-objects-table-team-shared-like-saved-views"},{"title":"Expand the analytics strip above the object's table","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/analytics/expand","href":"/api-reference/crm/expand-the-analytics-strip-above-the-objects-table"},{"title":"Give a saved view its own dashboard (mode \"own\": starts as a copy of the object's panels) or hand it back to the object's shared one (mode \"shared\")","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/objects/{objectName}/views/{viewName}/analytics/scope","href":"/api-reference/crm/give-a-saved-view-its-own-dashboard-mode-\"own\":-starts-as-a-copy-of-the-objects-panels-or-hand-it-back-to-the-objects-shared-one-mode-\"shared\""},{"title":"Enrich cell","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/enrich/cell","href":"/api-reference/crm/enrich-cell"},{"title":"Enrich object","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/enrich/object","href":"/api-reference/crm/enrich-object"},{"title":"Search people","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/people/search","href":"/api-reference/crm/search-people"},{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/company/search","href":"/api-reference/crm/search-companies"},{"title":"Search jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/jobs/search","href":"/api-reference/crm/search-jobs"},{"title":"Person profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/person","href":"/api-reference/crm/person-profile"},{"title":"Company profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/company","href":"/api-reference/crm/company-profile"},{"title":"Person contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/person/contact","href":"/api-reference/crm/person-contact"},{"title":"Look up up to 100 people or company profiles without buying emails or phones. Pass kind (people|companies) and lookups; results preserve inputIndex. People require linkedinUrl or email; companies require domain or linkedinUrl","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/profiles/bulk","href":"/api-reference/crm/look-up-up-to-100-people-or-company-profiles-without-buying-emails-or-phones-pass-kind-people|companies-and-lookups;-results-preserve-inputindex-people-require-linkedinurl-or-email;-companies-require-domain-or-linkedinurl"},{"title":"Read company employees, founders, funding, investors, acquisitions, or investments. Pass domain or linkedinUrl, kind, limit (1–100), and optional pageToken. Does not import CRM records or buy contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/company/related","href":"/api-reference/crm/read-company-employees-founders-funding-investors-acquisitions-or-investments-pass-domain-or-linkedinurl-kind-limit-1–100-and-optional-pagetoken-does-not-import-crm-records-or-buy-contacts"},{"title":"Preview search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichment/search/preview","href":"/api-reference/crm/preview-search"},{"title":"List Lead Finder filter vocabularies: exact enum values (seniorities, functions, industries, headcount, company types, languages) and curated suggestions (titles, locations, company HQ, universities, skills, keywords)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /local/enrichment/filter-options","href":"/api-reference/crm/list-lead-finder-filter-vocabularies:-exact-enum-values-seniorities-functions-industries-headcount-company-types-languages-and-curated-suggestions-titles-locations-company-hq-universities-skills-keywords"},{"title":"List CRM templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/templates","href":"/api-reference/crm/list-crm-templates"},{"title":"Install CRM template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/templates/{templateId}/install","href":"/api-reference/crm/install-crm-template"},{"title":"Remove template sample data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/templates/{templateId}/remove-sample-data","href":"/api-reference/crm/remove-template-sample-data"},{"title":"List CRM automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/automations","href":"/api-reference/crm/list-crm-automations"},{"title":"Toggle CRM automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /crm/automations/{automationId}","href":"/api-reference/crm/toggle-crm-automation"},{"title":"Start a server-side CSV export of a CRM object into the workspace files (/exports). Returns at once; one export runs per workspace, and a second start returns the running one","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /crm/exports","href":"/api-reference/crm/start-a-server-side-csv-export-of-a-crm-object-into-the-workspace-files-exports-returns-at-once;-one-export-runs-per-workspace-and-a-second-start-returns-the-running-one"},{"title":"Read a CRM CSV export's progress, and its file path and download link once done","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /crm/exports/{jobId}","href":"/api-reference/crm/read-a-crm-csv-exports-progress-and-its-file-path-and-download-link-once-done"}]},{"group":"members","pages":[{"title":"Live presence (online / away / offline) for workspace members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/presence","href":"/api-reference/members/live-presence-online-away-offline-for-workspace-members"},{"title":"A member's profile: name, email, tagline, role, timezone, presence, open task count","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/{userId}","href":"/api-reference/members/a-members-profile:-name-email-tagline-role-timezone-presence-open-task-count"},{"title":"A member's recent comments and record changes across the CRM, newest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/{userId}/activity","href":"/api-reference/members/a-members-recent-comments-and-record-changes-across-the-crm-newest-first"},{"title":"Open tasks assigned to a member (plus ones completed today)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/{userId}/tasks","href":"/api-reference/members/open-tasks-assigned-to-a-member-plus-ones-completed-today"},{"title":"Your own member profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /me/profile","href":"/api-reference/members/your-own-member-profile"},{"title":"Update your name, tagline, avatar URL, or timezone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /me/profile","href":"/api-reference/members/update-your-name-tagline-avatar-url-or-timezone"},{"title":"Get a one-time URL to POST an avatar image to; then PUT /me/avatar with the returned storageId","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /me/avatar/upload-url","href":"/api-reference/members/get-a-one-time-url-to-post-an-avatar-image-to;-then-put-meavatar-with-the-returned-storageid"},{"title":"Set your avatar from an uploaded storageId","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /me/avatar","href":"/api-reference/members/set-your-avatar-from-an-uploaded-storageid"},{"title":"Remove your avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /me/avatar","href":"/api-reference/members/remove-your-avatar"}]},{"group":"meetings","pages":[{"title":"List meetings, newest first, with status and participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings","href":"/api-reference/meetings/list-meetings-newest-first-with-status-and-participants"},{"title":"Get short-lived signed playback/download URLs for a meeting's recorded video (MP4) and audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{meetingEntryId}/recording","href":"/api-reference/meetings/get-short-lived-signed-playbackdownload-urls-for-a-meetings-recorded-video-mp4-and-audio"},{"title":"Read a meeting's transcript, in order, one page at a time","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{meetingEntryId}/transcript","href":"/api-reference/meetings/read-a-meetings-transcript-in-order-one-page-at-a-time"},{"title":"Append up to 500 transcript segments to a meeting (speakers with an email link to existing people)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /meetings/{meetingEntryId}/transcript","href":"/api-reference/meetings/append-up-to-500-transcript-segments-to-a-meeting-speakers-with-an-email-link-to-existing-people"},{"title":"Delete a batch of a meeting's transcript segments; repeat until `done` before re-appending","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /meetings/{meetingEntryId}/transcript","href":"/api-reference/meetings/delete-a-batch-of-a-meetings-transcript-segments;-repeat-until-`done`-before-re-appending"},{"title":"List a meeting's action items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{meetingEntryId}/action-items","href":"/api-reference/meetings/list-a-meetings-action-items"},{"title":"Add action items to a meeting; `replace: true` swaps the whole list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /meetings/{meetingEntryId}/action-items","href":"/api-reference/meetings/add-action-items-to-a-meeting;-`replace:-true`-swaps-the-whole-list"},{"title":"Delete one action item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /meetings/action-items/{itemId}","href":"/api-reference/meetings/delete-one-action-item"},{"title":"Tick or untick one action item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /meetings/action-items/{itemId}","href":"/api-reference/meetings/tick-or-untick-one-action-item"},{"title":"Who was in the meeting, merged with the linked calendar invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{meetingEntryId}/participants","href":"/api-reference/meetings/who-was-in-the-meeting-merged-with-the-linked-calendar-invite"},{"title":"Record attendees by name/email; known members and existing people are linked, nobody is created","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /meetings/{meetingEntryId}/participants","href":"/api-reference/meetings/record-attendees-by-nameemail;-known-members-and-existing-people-are-linked-nobody-is-created"},{"title":"Whether a meeting is shared with the whole workspace, and whether you may change that","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{meetingEntryId}/sharing","href":"/api-reference/meetings/whether-a-meeting-is-shared-with-the-whole-workspace-and-whether-you-may-change-that"},{"title":"Share one meeting with the workspace, or take it back to owner + invitees","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /meetings/{meetingEntryId}/sharing","href":"/api-reference/meetings/share-one-meeting-with-the-workspace-or-take-it-back-to-owner-+-invitees"}]},{"group":"email","pages":[{"title":"Verify sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/identities/verify","href":"/api-reference/email/verify-sender"},{"title":"List identities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/sending-identities","href":"/api-reference/email/list-identities"},{"title":"Create sending identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sending-identities","href":"/api-reference/email/create-sending-identity"},{"title":"Refresh identity status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sending-identities/{identityId}/status","href":"/api-reference/email/refresh-identity-status"},{"title":"Begin verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sending-identities/{identityId}/verify","href":"/api-reference/email/begin-verification"},{"title":"Sender status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/identities/{identity}/status","href":"/api-reference/email/sender-status"},{"title":"Identity DNS records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/sending-identities/{identityId}/dns","href":"/api-reference/email/identity-dns-records"},{"title":"Disable sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sending-identities/{identity}/disable","href":"/api-reference/email/disable-sender"},{"title":"Restore sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sending-identities/{identity}/restore","href":"/api-reference/email/restore-sender"},{"title":"Permanently delete a sender (or every sender on a domain) from the workspace; re-adding it requires verification from scratch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /email/sending-identities/{identity}","href":"/api-reference/email/permanently-delete-a-sender-or-every-sender-on-a-domain-from-the-workspace;-re-adding-it-requires-verification-from-scratch"},{"title":"Search authorized synced mailbox headers with bounded cursor pagination. isDone covers stored records, not provider completeness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/inbox/search","href":"/api-reference/email/search-authorized-synced-mailbox-headers-with-bounded-cursor-pagination-isdone-covers-stored-records-not-provider-completeness"},{"title":"Read a bounded page of synced headers using an exact thread handle from inbox search; bodies remain on demand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/inbox/threads/{threadHandle}","href":"/api-reference/email/read-a-bounded-page-of-synced-headers-using-an-exact-thread-handle-from-inbox-search;-bodies-remain-on-demand"},{"title":"Read a bounded stored body using an exact message handle from inbox search; rechecks mailbox and record privacy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/inbox/messages/{messageHandle}","href":"/api-reference/email/read-a-bounded-stored-body-using-an-exact-message-handle-from-inbox-search;-rechecks-mailbox-and-record-privacy"},{"title":"Create an editable Dench email draft and synchronize its selected native mailbox asynchronously. Use a stable requestId for retries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/drafts","href":"/api-reference/email/create-an-editable-dench-email-draft-and-synchronize-its-selected-native-mailbox-asynchronously-use-a-stable-requestid-for-retries"},{"title":"Read an email draft, eligible senders and provider sync status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/drafts/{draftId}","href":"/api-reference/email/read-an-email-draft-eligible-senders-and-provider-sync-status"},{"title":"Save draft content using expectedRevision; sender changes require a new draft after provider binding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /email/drafts/{draftId}","href":"/api-reference/email/save-draft-content-using-expectedrevision;-sender-changes-require-a-new-draft-after-provider-binding"},{"title":"List native mailboxes this caller may use","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/drafts/senders","href":"/api-reference/email/list-native-mailboxes-this-caller-may-use"},{"title":"Send the current Dench draft revision through its native mailbox. Repeated requests share a durable receipt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/drafts/{draftId}/send","href":"/api-reference/email/send-the-current-dench-draft-revision-through-its-native-mailbox-repeated-requests-share-a-durable-receipt"},{"title":"Upload attachment bytes authorized against this draft before adding its storage reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/drafts/{draftId}/attachments","href":"/api-reference/email/upload-attachment-bytes-authorized-against-this-draft-before-adding-its-storage-reference"},{"title":"Load the selected mailbox signature for explicit visible insertion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/drafts/{draftId}/signature","href":"/api-reference/email/load-the-selected-mailbox-signature-for-explicit-visible-insertion"},{"title":"Send through a native Gmail or Outlook mailbox with a durable request receipt. Only use for an explicit send request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/native/send","href":"/api-reference/email/send-through-a-native-gmail-or-outlook-mailbox-with-a-durable-request-receipt-only-use-for-an-explicit-send-request"},{"title":"Send email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/send","href":"/api-reference/email/send-email"},{"title":"Message status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/messages/{messageId}","href":"/api-reference/email/message-status"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/messages","href":"/api-reference/email/list-messages"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/templates","href":"/api-reference/email/create-template"},{"title":"Preview template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/templates/{templateId}/preview","href":"/api-reference/email/preview-template"},{"title":"List managed email campaigns (paginated, optional status filter)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/campaigns","href":"/api-reference/email/list-managed-email-campaigns-paginated-optional-status-filter"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns","href":"/api-reference/email/create-campaign"},{"title":"Campaign status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/campaigns/{campaignId}","href":"/api-reference/email/campaign-status"},{"title":"List a campaign's recipients (paginated, optional status filter)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/campaigns/{campaignId}/recipients","href":"/api-reference/email/list-a-campaigns-recipients-paginated-optional-status-filter"},{"title":"Add recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/recipients","href":"/api-reference/email/add-recipients"},{"title":"Preview campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/preview","href":"/api-reference/email/preview-campaign"},{"title":"Submit campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/submit","href":"/api-reference/email/submit-campaign"},{"title":"Pause campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/pause","href":"/api-reference/email/pause-campaign"},{"title":"Resume campaign","description":"Resume a paused email campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/resume","href":"/api-reference/email/resume-campaign"},{"title":"Cancel campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/cancel","href":"/api-reference/email/cancel-campaign"},{"title":"Add campaign recipients from a CRM object: pick the object, the email field, and the entry ids","description":"Add campaign recipients from a CRM object: pick the object, the email field, and the entry ids.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/campaigns/{campaignId}/recipients/from-object","href":"/api-reference/email/add-campaign-recipients-from-a-crm-object:-pick-the-object-the-email-field-and-the-entry-ids"},{"title":"List the workspace's follow-up sequences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/sequences","href":"/api-reference/email/list-the-workspaces-follow-up-sequences"},{"title":"Create a follow-up sequence from a connected inbox or verified sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences","href":"/api-reference/email/create-a-follow-up-sequence-from-a-connected-inbox-or-verified-sender"},{"title":"Read a sequence with its ordered steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/sequences/{sequenceId}","href":"/api-reference/email/read-a-sequence-with-its-ordered-steps"},{"title":"Update a sequence's name, sender, or reply/stop settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}","href":"/api-reference/email/update-a-sequences-name-sender-or-replystop-settings"},{"title":"Activate a sequence so its enrollments begin sending","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/activate","href":"/api-reference/email/activate-a-sequence-so-its-enrollments-begin-sending"},{"title":"Deactivate a sequence (pause sending, revert to draft)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/deactivate","href":"/api-reference/email/deactivate-a-sequence-pause-sending-revert-to-draft"},{"title":"Archive a sequence (stops all sending)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/archive","href":"/api-reference/email/archive-a-sequence-stops-all-sending"},{"title":"Add a step (subject, body, and wait delay) to a sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/steps","href":"/api-reference/email/add-a-step-subject-body-and-wait-delay-to-a-sequence"},{"title":"Update a sequence step's subject, body, or delay","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/steps/{stepId}","href":"/api-reference/email/update-a-sequence-steps-subject-body-or-delay"},{"title":"Remove a step from a sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/steps/{stepId}/remove","href":"/api-reference/email/remove-a-step-from-a-sequence"},{"title":"Reorder a sequence's steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/steps/reorder","href":"/api-reference/email/reorder-a-sequences-steps"},{"title":"Enroll explicit recipients into a sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/enroll","href":"/api-reference/email/enroll-explicit-recipients-into-a-sequence"},{"title":"Enroll people from a CRM object: pick the object, the email field, and the entry ids","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/{sequenceId}/enroll/from-object","href":"/api-reference/email/enroll-people-from-a-crm-object:-pick-the-object-the-email-field-and-the-entry-ids"},{"title":"List a sequence's enrollments (paginated, optional status filter)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email/sequences/{sequenceId}/enrollments","href":"/api-reference/email/list-a-sequences-enrollments-paginated-optional-status-filter"},{"title":"Pause one enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/enrollments/{enrollmentId}/pause","href":"/api-reference/email/pause-one-enrollment"},{"title":"Resume one paused enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/enrollments/{enrollmentId}/resume","href":"/api-reference/email/resume-one-paused-enrollment"},{"title":"Stop one enrollment (no further steps send)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /email/sequences/enrollments/{enrollmentId}/stop","href":"/api-reference/email/stop-one-enrollment-no-further-steps-send"}]},{"group":"routines","pages":[{"title":"List routines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routines","href":"/api-reference/routines/list-routines"},{"title":"Create routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routines","href":"/api-reference/routines/create-routine"},{"title":"Run history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routines/history","href":"/api-reference/routines/run-history"},{"title":"Get routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routines/{jobId}","href":"/api-reference/routines/get-routine"},{"title":"Delete routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /routines/{jobId}","href":"/api-reference/routines/delete-routine"},{"title":"Update routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /routines/{jobId}","href":"/api-reference/routines/update-routine"},{"title":"Enable routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routines/{jobId}/enable","href":"/api-reference/routines/enable-routine"},{"title":"Disable routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routines/{jobId}/disable","href":"/api-reference/routines/disable-routine"},{"title":"Run routine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routines/{jobId}/run","href":"/api-reference/routines/run-routine"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routines/{jobId}/runs","href":"/api-reference/routines/list-runs"}]},{"group":"files","pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /files","href":"/api-reference/files/list-files"},{"title":"Delete file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /files","href":"/api-reference/files/delete-file"},{"title":"Read a workspace file's text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /files/content","href":"/api-reference/files/read-a-workspace-files-text"},{"title":"Write a workspace file's text","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /files/content","href":"/api-reference/files/write-a-workspace-files-text"},{"title":"Download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /files/download-url","href":"/api-reference/files/download-url"},{"title":"Move file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /files/move","href":"/api-reference/files/move-file"},{"title":"Create a workspace directory (and any missing parents). Idempotent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /files/mkdir","href":"/api-reference/files/create-a-workspace-directory-and-any-missing-parents-idempotent"},{"title":"Stage files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /files/stage","href":"/api-reference/files/stage-files"}]},{"group":"gateway","pages":[{"title":"Web search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /search","href":"/api-reference/gateway/web-search"},{"title":"Page contents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /search/contents","href":"/api-reference/gateway/page-contents"},{"title":"Answer question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /search/answer","href":"/api-reference/gateway/answer-question"},{"title":"Read page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-scrape-markdown","href":"/api-reference/gateway/read-page"},{"title":"Look up brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/brand-retrieve","href":"/api-reference/gateway/look-up-brand"},{"title":"List site pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-sitemap","href":"/api-reference/gateway/list-site-pages"},{"title":"Crawl site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-crawl","href":"/api-reference/gateway/crawl-site"},{"title":"Screenshot page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-screenshot","href":"/api-reference/gateway/screenshot-page"},{"title":"Extract page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-extract","href":"/api-reference/gateway/extract-page"},{"title":"Extract product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-product","href":"/api-reference/gateway/extract-product"},{"title":"Find competitors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/web-competitors","href":"/api-reference/gateway/find-competitors"},{"title":"Read styleguide","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/brand-styleguide","href":"/api-reference/gateway/read-styleguide"},{"title":"Read fonts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/brand-fonts","href":"/api-reference/gateway/read-fonts"},{"title":"Classify brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/classify-naics","href":"/api-reference/gateway/classify-brand"},{"title":"Search brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /context/brand-search","href":"/api-reference/gateway/search-brands"},{"title":"Generate image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /images/generations","href":"/api-reference/gateway/generate-image"},{"title":"Edit image","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /images/edits","href":"/api-reference/gateway/edit-image"},{"title":"List every connected integration — connected apps plus the Gmail, Outlook, Calendar, LinkedIn and Slack connections Dench provides itself (Slack rows report source: dench)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /integrations","href":"/api-reference/gateway/list-every-connected-integration-—-connected-apps-plus-the-gmail-outlook-calendar-linkedin-and-slack-connections-dench-provides-itself-slack-rows-report-source:-dench"},{"title":"Tool status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tools/status","href":"/api-reference/gateway/tool-status"},{"title":"Connect tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tools/connections","href":"/api-reference/gateway/connect-tool"},{"title":"Search tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tools/search","href":"/api-reference/gateway/search-tools"},{"title":"Run tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tools/run","href":"/api-reference/gateway/run-tool"},{"title":"Disconnect tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tools/connections/{connectionId}","href":"/api-reference/gateway/disconnect-tool"},{"title":"List human names given to connected accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tools/labels","href":"/api-reference/gateway/list-human-names-given-to-connected-accounts"},{"title":"Name a connected account, or clear its name with an empty string","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /tools/connections/{connectionId}/label","href":"/api-reference/gateway/name-a-connected-account-or-clear-its-name-with-an-empty-string"},{"title":"List custom MCP servers connected in this workspace that you can use","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp/servers","href":"/api-reference/gateway/list-custom-mcp-servers-connected-in-this-workspace-that-you-can-use"},{"title":"List cached tools exposed by a connected custom MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp/servers/{server}/tools","href":"/api-reference/gateway/list-cached-tools-exposed-by-a-connected-custom-mcp-server"},{"title":"Call a tool on a connected custom MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mcp/servers/{server}/call","href":"/api-reference/gateway/call-a-tool-on-a-connected-custom-mcp-server"}]},{"group":"apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /apps","href":"/api-reference/apps/list-apps"},{"title":"Scaffold and register a new App Store app","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps","href":"/api-reference/apps/scaffold-and-register-a-new-app-store-app"},{"title":"List Discover listings — Official (Dench) + Community shelves","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /apps/gallery","href":"/api-reference/apps/list-discover-listings-—-official-dench-+-community-shelves"},{"title":"Install an App Store listing into the workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps/install","href":"/api-reference/apps/install-an-app-store-listing-into-the-workspace"},{"title":"Publish an app's files as a versioned App Store listing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps/publish","href":"/api-reference/apps/publish-an-apps-files-as-a-versioned-app-store-listing"},{"title":"Uninstall an app from the workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /apps/{slug}","href":"/api-reference/apps/uninstall-an-app-from-the-workspace"},{"title":"Enable or disable an installed app","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /apps/{slug}","href":"/api-reference/apps/enable-or-disable-an-installed-app"},{"title":"Pin or unpin an installed app in the rail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps/{slug}/pin","href":"/api-reference/apps/pin-or-unpin-an-installed-app-in-the-rail"},{"title":"Share an app you added with the workspace (shared) or make it private to you again (private). Owner only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps/{slug}/visibility","href":"/api-reference/apps/share-an-app-you-added-with-the-workspace-shared-or-make-it-private-to-you-again-private-owner-only"},{"title":"Validate a .dench.app folder: manifest, permissions, and every window.dench call it makes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /local/apps/validate","href":"/api-reference/apps/validate-a-denchapp-folder:-manifest-permissions-and-every-windowdench-call-it-makes"},{"title":"List an app's registered webhooks (URLs, never secrets)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /apps/{slug}/webhooks","href":"/api-reference/apps/list-an-apps-registered-webhooks-urls-never-secrets"},{"title":"Register an inbound webhook for an app. Returns the URL and signing secret ONCE","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /apps/{slug}/webhooks","href":"/api-reference/apps/register-an-inbound-webhook-for-an-app-returns-the-url-and-signing-secret-once"},{"title":"Read events an app webhook received since a timestamp","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /apps/{slug}/webhooks/{hookName}/events","href":"/api-reference/apps/read-events-an-app-webhook-received-since-a-timestamp"},{"title":"Remove an app webhook and every event it stored","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /apps/{slug}/webhooks/{hookName}","href":"/api-reference/apps/remove-an-app-webhook-and-every-event-it-stored"}]},{"group":"browser","pages":[{"title":"Drive Dench Browser with a single interactive action (open, inspect, click, fill, type, screenshot, stop). Pass the step in `action` plus its arguments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /browser/cli","href":"/api-reference/browser/drive-dench-browser-with-a-single-interactive-action-open-inspect-click-fill-type-screenshot-stop-pass-the-step-in-`action`-plus-its-arguments"},{"title":"Create a Dench Browser session and return a CDP connect URL for Playwright (chromium.connectOverCDP) plus a live-view URL. Use for durable scripts run from the sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /browser/sessions","href":"/api-reference/browser/create-a-dench-browser-session-and-return-a-cdp-connect-url-for-playwright-chromiumconnectovercdp-plus-a-live-view-url-use-for-durable-scripts-run-from-the-sandbox"},{"title":"Get the status, connect URL, and live-view URL for a Dench Browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /browser/sessions/{sessionId}","href":"/api-reference/browser/get-the-status-connect-url-and-live-view-url-for-a-dench-browser-session"},{"title":"Stop a Dench Browser session and release the remote browser","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /browser/sessions/{sessionId}","href":"/api-reference/browser/stop-a-dench-browser-session-and-release-the-remote-browser"}]},{"group":"agent-config","pages":[{"title":"Identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/identity","href":"/api-reference/agent-config/identity"},{"title":"Update identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/identity","href":"/api-reference/agent-config/update-identity"},{"title":"Organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/organisation","href":"/api-reference/agent-config/organisation"},{"title":"Update organisation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/organisation","href":"/api-reference/agent-config/update-organisation"},{"title":"User profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/user","href":"/api-reference/agent-config/user-profile"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/user","href":"/api-reference/agent-config/update-user"},{"title":"Tool notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/tools","href":"/api-reference/agent-config/tool-notes"},{"title":"Update tool notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/tools","href":"/api-reference/agent-config/update-tool-notes"},{"title":"Aggregate memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/mem","href":"/api-reference/agent-config/aggregate-memory"},{"title":"Update memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/mem","href":"/api-reference/agent-config/update-memory"},{"title":"Bootstrap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/bootstrap","href":"/api-reference/agent-config/bootstrap"},{"title":"Complete bootstrap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-config/bootstrap/complete","href":"/api-reference/agent-config/complete-bootstrap"},{"title":"Bootstrap template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/bootstrap/template","href":"/api-reference/agent-config/bootstrap-template"},{"title":"Default model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/model/default","href":"/api-reference/agent-config/default-model"},{"title":"Thread model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agent-config/model/threads/{threadId}","href":"/api-reference/agent-config/thread-model"},{"title":"Today's log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/daily/today","href":"/api-reference/agent-config/todays-log"},{"title":"Daily log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-config/daily/{date}","href":"/api-reference/agent-config/daily-log"}]},{"group":"notifications","pages":[{"title":"List your notifications (inbox, unread, archived, or all)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notifications","href":"/api-reference/notifications/list-your-notifications-inbox-unread-archived-or-all"},{"title":"How many unread notifications you have","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notifications/unread-count","href":"/api-reference/notifications/how-many-unread-notifications-you-have"},{"title":"Mark a notification read (or unread)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /notifications/{notificationId}","href":"/api-reference/notifications/mark-a-notification-read-or-unread"},{"title":"Mark every inbox notification read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /notifications/read-all","href":"/api-reference/notifications/mark-every-inbox-notification-read"},{"title":"Archive a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /notifications/{notificationId}/archive","href":"/api-reference/notifications/archive-a-notification"},{"title":"Read your notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notifications/preferences","href":"/api-reference/notifications/read-your-notification-preferences"},{"title":"Update your notification preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /notifications/preferences","href":"/api-reference/notifications/update-your-notification-preferences"}]},{"group":"settings","pages":[{"title":"Read the workspace's Sync switches (accounts from email, contacts from LinkedIn, Slack Connect, calendar, dossier, tasks from email, lead auto-qualify, summaries and Brief). All on by default","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /settings/sync","href":"/api-reference/settings/read-the-workspaces-sync-switches-accounts-from-email-contacts-from-linkedin-slack-connect-calendar-dossier-tasks-from-email-lead-auto-qualify-summaries-and-brief-all-on-by-default"},{"title":"Flip Sync switches (admin). Partial patch: only the keys sent change. Off stops new work; nothing already created is removed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /settings/sync","href":"/api-reference/settings/flip-sync-switches-admin-partial-patch:-only-the-keys-sent-change-off-stops-new-work;-nothing-already-created-is-removed"},{"title":"List the workspace's Slack announcement channel groups and the channels in each right now (admin). A group is a rule on channel names, channels picked by hand, or the customer channels Dench mapped to their workspaces. Read only: it cannot send an announcement or change a group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /settings/announcement-groups","href":"/api-reference/settings/list-the-workspaces-slack-announcement-channel-groups-and-the-channels-in-each-right-now-admin-a-group-is-a-rule-on-channel-names-channels-picked-by-hand-or-the-customer-channels-dench-mapped-to-their-workspaces-read-only:-it-cannot-send-an-announcement-or-change-a-group"},{"title":"Make or change a Slack announcement channel group (admin): a rule on channel names, or channels picked by name; add or take out single channels without restating the group; rename it. It sends nothing: a group only ticks channels in the New announcement dialog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /settings/announcement-groups","href":"/api-reference/settings/make-or-change-a-slack-announcement-channel-group-admin:-a-rule-on-channel-names-or-channels-picked-by-name;-add-or-take-out-single-channels-without-restating-the-group;-rename-it-it-sends-nothing:-a-group-only-ticks-channels-in-the-new-announcement-dialog"},{"title":"Delete a Slack announcement channel group by name (admin). Announcements already sent or scheduled keep their channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /settings/announcement-groups/{name}","href":"/api-reference/settings/delete-a-slack-announcement-channel-group-by-name-admin-announcements-already-sent-or-scheduled-keep-their-channels"}]}]}]},"basePath":"","title":"Cancel campaign - Dench Docs","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}