Flips an active campaign to paused. Only active campaigns can be paused — every other status returns 400. The request body is empty.Under the hood the server does two things:
A compare-and-set update on campaigns.status (fast, the only step that can fail the request).
Completes every outstanding Trigger.dev waitpoint token for this campaign’s leads with { paused: true }, so sleeping per-lead tasks wake up and re-check the status. This step is best-effort — token-completion failures are logged but do not surface as a 500.
AI agent notes
When to call. After a bounce spike, a misconfigured template, or explicit user intent. Validate on your side first — there’s no server-side dry-run.What changes immediately.campaigns.status flips to paused synchronously. Sleeping tasks continue to exist on Trigger.dev until their waitpoint tokens resolve, but they will no-op on the pause check at the top of the engine loop.Idempotency. Not idempotent — a second call while already paused returns 400 (Only active campaigns can be paused). Treat that as a safe success for user-facing flows.Follow-up. Poll GET /api/campaigns/{id} to confirm status === "paused" before reporting success to the human. Resume later with POST /api/campaigns/{id}/resume.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
required
Campaign UUID
Response
Campaign paused. Returns the updated campaign row with status: "paused".
campaign
object
required
The campaign row after the status transition. status is now paused.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pixie Docs","description":"GTM intelligence platform for founders","colors":{"primary":"#00308F","light":"#4169E1","dark":"#001F5C"},"logo":{"light":"https://mintcdn.com/puffle-a7721060/DUkYTzv9fN1jgWMK/logo-light.svg?fit=max\u0026auto=format\u0026n=DUkYTzv9fN1jgWMK\u0026q=85\u0026s=6f6ed3122fe70c6655b8e0f15a633429","dark":"https://mintcdn.com/puffle-a7721060/DUkYTzv9fN1jgWMK/logo-dark.svg?fit=max\u0026auto=format\u0026n=DUkYTzv9fN1jgWMK\u0026q=85\u0026s=6e0cea776235f47330d3f503b89d3014"},"favicon":"https://mintcdn.com/puffle-a7721060/DUkYTzv9fN1jgWMK/favicon.svg?fit=max\u0026auto=format\u0026n=DUkYTzv9fN1jgWMK\u0026q=85\u0026s=4f98900fd6bf3ca38403f68e7aef9f09","api":{"openapi":"api-reference/openapi.json","params":{"post":["x-param-pill"]}},"background":{"color":{"light":"#FFFFFF","dark":"#000000"}},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"puffle-a7721060","hasAudioNarration":false,"actualSubdomain":"puffle-a7721060","customDomains":["docs.pixiegtm.com"],"gitSource":{"type":"github","owner":"developiq-ai","repo":"pixie-app","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf4cb1f325da4ba4e0ec9b","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"Endpoints","count":71},{"language":"default","tag":"Lead Finder","count":12},{"language":"default","tag":"Outbound","count":11},{"language":"default","tag":"Unibox","count":7},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Email Inboxes","count":6},{"language":"default","tag":"Sending Domains","count":6},{"language":"default","tag":"Documentation","count":6},{"language":"default","tag":"Outbound Contacts","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".pixie-welcome-callout{display:flex;gap:16px;align-items:flex-start;margin:32px 0 24px;padding:18px 20px;border:1px solid #7dd3a8;border-radius:10px;background:#f1fbf5;color:#047857}.pixie-welcome-callout-icon{flex:none;color:#059669;font-size:20px;line-height:1.3}.pixie-welcome-callout-title{display:block;margin:0 0 12px;color:#047857;font-weight:700}.pixie-welcome-callout-copy{display:block;color:#047857}html.dark .pixie-welcome-callout{border-color:#047857;background:#001f12;color:#34d399}html.dark .pixie-welcome-callout-icon,html.dark .pixie-welcome-callout-title,html.dark .pixie-welcome-callout-copy{color:#34d399!important}"}],"page":{"pagePath":"api-reference/campaigns/pause-campaign","slug":"/api-reference/campaigns/pause-campaign","pageMetadata":{"title":"Pause Campaign","description":"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.","openapi":"post /api/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},"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: \"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`CLI:`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pixie`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` campaign`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pause`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`i`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`d`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`Flips an `,_jsx(_components.code,{children:`active`}),` campaign to `,_jsx(_components.code,{children:`paused`}),`. Only `,_jsx(_components.code,{children:`active`}),` campaigns can be paused — every other status returns 400. The request body is empty.`]}),`\n`,_jsx(_components.p,{children:`Under the hood the server does two things:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`A compare-and-set update on `,_jsx(_components.code,{children:`campaigns.status`}),` (fast, the only step that can fail the request).`]}),`\n`,_jsxs(_components.li,{children:[`Completes every outstanding Trigger.dev waitpoint token for this campaign’s leads with `,_jsx(_components.code,{children:`{ paused: true }`}),`, so sleeping per-lead tasks wake up and re-check the status. This step is best-effort — token-completion failures are logged but do not surface as a 500.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`ai-agent-notes`,children:`AI agent notes`}),`\n`,_jsxs(Note,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`When to call.`}),` After a bounce spike, a misconfigured template, or explicit user intent. Validate on your side first — there’s no server-side dry-run.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`What changes immediately.`}),` `,_jsx(_components.code,{children:`campaigns.status`}),` flips to `,_jsx(_components.code,{children:`paused`}),` synchronously. Sleeping tasks continue to exist on Trigger.dev until their waitpoint tokens resolve, but they will no-op on the pause check at the top of the engine loop.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Idempotency.`}),` Not idempotent — a second call while already `,_jsx(_components.code,{children:`paused`}),` returns 400 (`,_jsx(_components.code,{children:`Only active campaigns can be paused`}),`). Treat that as a safe success for user-facing flows.`]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Follow-up.`}),` Poll `,_jsx(_components.code,{children:`GET /api/campaigns/{id}`}),` to confirm `,_jsx(_components.code,{children:`status === \"paused\"`}),` before reporting success to the human. Resume later with `,_jsx(_components.code,{children:`POST /api/campaigns/{id}/resume`}),`.`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Pause Campaign","description":"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.","openapi":"post /api/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"AI agent notes","slug":"ai-agent-notes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/puffle-a7721060/c08f9ef5836940ef/ai-agent-notes-bottom.js"],"openApiReferenceData":{"operation":{"operationId":"pauseCampaign","summary":"Pause Campaign","description":"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.","tags":["Campaigns"],"parameters":["79ee6092-799f-4ed3-b4bc-2b23aebed111"],"responses":{"200":"d61d5a4c-f650-493e-bc6b-9609d41e3a5c","400":"16b5715f-6b6b-4bd5-ab02-078c5c1be3d5","401":"fdb9d465-fe76-4457-b183-05a61c2eb8c6","404":"1d705b13-8e76-4d7e-8879-aa1e60119dfe","500":"77495095-9879-4456-9f07-a793fce2cae1"},"x-pixie-cli":{"command":"pixie campaign pause","auth":"apiKey","flags":[{"name":"id","from":"params.id","type":"string","required":true,"description":"Campaign UUID"}]},"method":"post","type":"path","servers":["3f705fd1-36b3-48c2-9ff5-0b216d4c8835"],"security":["389a9986-625f-46f1-8c08-80e2d40d3784"],"path":"/api/campaigns/{id}/pause","baseUrlOptions":["https://app.pixiegtm.com"],"title":"Pause Campaign","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"79ee6092-799f-4ed3-b4bc-2b23aebed111":{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Campaign UUID","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"d61d5a4c-f650-493e-bc6b-9609d41e3a5c":{"description":"Campaign paused. Returns the updated campaign row with `status: \"paused\"`.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string","description":"String value with endpoint-specific validation.","isRequired":true,"uniqueKey":"campaign.id","typeLabel":"string"},"user_id":{"type":"string","description":"String value with endpoint-specific validation.","isRequired":true,"uniqueKey":"campaign.user_id","typeLabel":"string"},"type":{"type":"string","enum":["linkedin","email","multi_channel"],"description":"Channel mode for this campaign. Immutable after creation.","isRequired":true,"uniqueKey":"campaign.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"campaign.name","typeLabel":"string"},"status":{"type":"string","enum":["draft","launching","active","paused","completed"],"description":"Lifecycle state. `draft` is editable; `launching` is transitional; `active` is sending; `paused` halts sends until resumed; `completed` is terminal.","isRequired":true,"uniqueKey":"campaign.status","typeLabel":"enum\u003cstring>"},"daily_limit":{"oneOf":[{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"campaign.daily_limit.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"campaign.daily_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.daily_limit","typeLabel":"integer | null"},"stop_on_reply":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"campaign.stop_on_reply.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"campaign.stop_on_reply.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.stop_on_reply","typeLabel":"boolean | null"},"open_tracking":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"campaign.open_tracking.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"campaign.open_tracking.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.open_tracking","typeLabel":"boolean | null"},"signature":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.signature.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.signature.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.signature","typeLabel":"string | null"},"skip_other_campaigns":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"campaign.skip_other_campaigns.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"campaign.skip_other_campaigns.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.skip_other_campaigns","typeLabel":"boolean | null"},"operating_hours":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"campaign.operating_hours.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"campaign.operating_hours.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"campaign.operating_hours.oneOf.1.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"campaign.operating_hours.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.operating_hours","typeLabel":"object | null"},"stats":{"oneOf":[{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.total","typeLabel":"integer"},"sent":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.sent","typeLabel":"integer"},"replied":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.replied","typeLabel":"integer"},"bounced":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.bounced","typeLabel":"integer"},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.completed","typeLabel":"integer"},"timed_out":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.timed_out","typeLabel":"integer"},"connection_sent":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.connection_sent","typeLabel":"integer"},"connected":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.connected","typeLabel":"integer"},"message_sent":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.stats.oneOf.0.message_sent","typeLabel":"integer"}},"additionalProperties":false,"description":"Counters updated atomically as leads progress. `total` is set at launch; the rest increment.","isRequired":true,"uniqueKey":"campaign.stats.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"sent":{"type":"integer","minimum":0,"maximum":9007199254740991},"replied":{"type":"integer","minimum":0,"maximum":9007199254740991},"bounced":{"type":"integer","minimum":0,"maximum":9007199254740991},"completed":{"type":"integer","minimum":0,"maximum":9007199254740991},"timed_out":{"type":"integer","minimum":0,"maximum":9007199254740991},"connection_sent":{"type":"integer","minimum":0,"maximum":9007199254740991},"connected":{"type":"integer","minimum":0,"maximum":9007199254740991},"message_sent":{"type":"integer","minimum":0,"maximum":9007199254740991}},"additionalProperties":false,"description":"Counters updated atomically as leads progress. `total` is set at launch; the rest increment.","isRequired":true,"uniqueKey":"campaign.stats.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.stats","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"campaign.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"campaign.updated_at","typeLabel":"string\u003cdate-time>"},"sender_accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"String value with endpoint-specific validation.","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["linkedin","email","multi_channel"],"description":"Channel mode for this campaign. Immutable after creation.","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"email_address":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].email_address.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].email_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].email_address","typeLabel":"string | null"},"provider_account_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].provider_account_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].provider_account_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].provider_account_id","typeLabel":"string | null"},"display_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].display_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].display_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].display_name","typeLabel":"string | null"},"status":{"type":"string","isRequired":true,"uniqueKey":"campaign.sender_accounts.items.[INDEX].status","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"campaign.sender_accounts.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.sender_accounts.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"campaign.sender_accounts.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.sender_accounts.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].last_name","typeLabel":"string | null"},"daily_limit":{"oneOf":[{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].daily_limit.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].daily_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].daily_limit","typeLabel":"integer | null"},"is_default_sender":{"type":"boolean","uniqueKey":"campaign.sender_accounts.items.[INDEX].is_default_sender","typeLabel":"boolean"},"weekly_connection_limit":{"oneOf":[{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_connection_limit.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_connection_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_connection_limit","typeLabel":"integer | null"},"weekly_message_limit":{"oneOf":[{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_message_limit.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_message_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].weekly_message_limit","typeLabel":"integer | null"},"is_premium":{"oneOf":[{"type":"boolean","uniqueKey":"campaign.sender_accounts.items.[INDEX].is_premium.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"campaign.sender_accounts.items.[INDEX].is_premium.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.sender_accounts.items.[INDEX].is_premium","typeLabel":"boolean | null"}},"required":["id","type","email_address","provider_account_id","display_name","status"],"additionalProperties":false,"uniqueKey":"campaign.sender_accounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"campaign.sender_accounts","typeLabel":"object[]"}},"required":["id","user_id","type","name","status","daily_limit","stop_on_reply","open_tracking","signature","skip_other_campaigns","operating_hours","stats","created_at","updated_at","sender_accounts"],"additionalProperties":false,"description":"The campaign row after the status transition. `status` is now `paused`.","isRequired":true,"uniqueKey":"campaign","typeLabel":"object"}},"required":["campaign"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"campaign":{"id":"\u003cstring>","user_id":"\u003cstring>","type":"linkedin","name":"\u003cstring>","status":"draft","daily_limit":4503599627370495,"stop_on_reply":true,"open_tracking":true,"signature":"\u003cstring>","skip_other_campaigns":true,"operating_hours":{},"stats":{"total":4503599627370495,"sent":4503599627370495,"replied":4503599627370495,"bounced":4503599627370495,"completed":4503599627370495,"timed_out":4503599627370495,"connection_sent":4503599627370495,"connected":4503599627370495,"message_sent":4503599627370495},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","sender_accounts":[{"id":"\u003cstring>","type":"linkedin","email_address":"\u003cstring>","provider_account_id":"\u003cstring>","display_name":"\u003cstring>","status":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","daily_limit":4503599627370495,"is_default_sender":true,"weekly_connection_limit":4503599627370495,"weekly_message_limit":4503599627370495,"is_premium":true}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"16b5715f-6b6b-4bd5-ab02-078c5c1be3d5":{"description":"Campaign is not in active status — only active campaigns can be paused.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fdb9d465-fe76-4457-b183-05a61c2eb8c6":{"description":"Missing or invalid Bearer token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1d705b13-8e76-4d7e-8879-aa1e60119dfe":{"description":"Campaign doesn't exist or isn't owned by the caller.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"77495095-9879-4456-9f07-a793fce2cae1":{"description":"Status CAS update failed. Waitpoint-token completion is best-effort and does not trigger a 500.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"389a9986-625f-46f1-8c08-80e2d40d3784":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"pk_live_...","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3f705fd1-36b3-48c2-9ff5-0b216d4c8835":{"url":"https://app.pixiegtm.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"pk_live_...","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"puffle-a7721060","siteName":"Pixie Docs","title":"Pause Campaign - Pixie Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T08:33:02.533Z","originalFileLocation":"api-reference/campaigns/pause-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=\"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pixie Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Pause Campaign - Pixie Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pixie Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://puffle-a7721060.mintlify.site/_mintlify/api/og/v2?division=Outbound\u0026amp;title=Pause+Campaign\u0026amp;description=Halt+an+active+campaign+mid-send.+Completes+waitpoint+tokens+so+Trigger.dev+tasks+observe+the+new+state.\u0026amp;theme=28e6c6df0ec34bca1003614e\u0026amp;signature=263921176132b358fc85de2105567b85002b89e5bbc5b3e9a7d2044c77fcb123\">\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=\"Pause Campaign - Pixie Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://puffle-a7721060.mintlify.site/_mintlify/api/og/v2?division=Outbound\u0026amp;title=Pause+Campaign\u0026amp;description=Halt+an+active+campaign+mid-send.+Completes+waitpoint+tokens+so+Trigger.dev+tasks+observe+the+new+state.\u0026amp;theme=28e6c6df0ec34bca1003614e\u0026amp;signature=263921176132b358fc85de2105567b85002b89e5bbc5b3e9a7d2044c77fcb123\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/puffle-a7721060/KPLMc4mzEDC3MpCF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pixie Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00308F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campaigns/pause-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pixiegtm.com/#organization\",\"name\":\"Pixie Docs\",\"url\":\"https://docs.pixiegtm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/puffle-a7721060/DUkYTzv9fN1jgWMK/logo-light.svg?fit=max\u0026auto=format\u0026n=DUkYTzv9fN1jgWMK\u0026q=85\u0026s=6f6ed3122fe70c6655b8e0f15a633429\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pixiegtm.com#website\",\"name\":\"Pixie Docs\",\"url\":\"https://docs.pixiegtm.com\",\"publisher\":{\"@id\":\"https://docs.pixiegtm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign#webpage\",\"url\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign\",\"name\":\"Pause Campaign\",\"description\":\"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\",\"dateModified\":\"2026-08-25T08:33:02.533Z\",\"isPartOf\":{\"@id\":\"https://docs.pixiegtm.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.pixiegtm.com/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Outbound\",\"item\":\"https://docs.pixiegtm.com/api-reference/campaigns/list-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Pause Campaign\",\"item\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign#apireference\",\"headline\":\"Pause Campaign\",\"name\":\"Pause Campaign\",\"description\":\"Halt an active campaign mid-send. Completes waitpoint tokens so Trigger.dev tasks observe the new state.\",\"url\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pixiegtm.com/api-reference/campaigns/pause-campaign#webpage\"},\"dateModified\":\"2026-08-25T08:33:02.533Z\",\"publisher\":{\"@id\":\"https://docs.pixiegtm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pixiegtm.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pixie Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pixie Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/campaigns/pause-campaign.md","siteName":"Pixie Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"Endpoints","pages":[{"title":"API Overview","href":"/api-reference/overview"},{"title":"API Keys","href":"/api-reference/api-keys/overview"},{"group":"Lead Finder","pages":[{"title":"List Lead Finder searches and latest run status","openapi":"get /api/lead-finder","href":"/api-reference/lead-finder/lead-finder.list"},{"title":"Create a Lead Finder search and start its first run","openapi":"post /api/lead-finder","href":"/api-reference/lead-finder/lead-finder.create"},{"title":"Get one Lead Finder search and paginated results","openapi":"get /api/lead-finder/{id}","href":"/api-reference/lead-finder/lead-finder.get"},{"title":"Update one Lead Finder search","openapi":"patch /api/lead-finder/{id}","href":"/api-reference/lead-finder/lead-finder.update"},{"title":"Resolve an exact Lead Finder title without selecting between duplicates","openapi":"get /api/lead-finder/resolve","href":"/api-reference/lead-finder/lead-finder.resolve"},{"title":"List sources available for new Lead Finder searches","openapi":"get /api/lead-finder/sources","href":"/api-reference/lead-finder/lead-finder.sources"},{"title":"Query reviewed Lead Finder enrichment values","openapi":"post /api/lead-finder/{id}/results/query","href":"/api-reference/lead-finder/lead-finder.query-results"},{"title":"Get one reviewed Lead Finder enrichment profile","openapi":"get /api/lead-finder/{id}/results/{resultId}/enrichment","href":"/api-reference/lead-finder/lead-finder.get-result-enrichment"},{"title":"List reviewed Lead Finder enrichment fields","openapi":"get /api/lead-finder/{id}/enrichment-fields","href":"/api-reference/lead-finder/lead-finder.enrichment-fields"},{"title":"Run every eligible Lead Finder search","openapi":"post /api/lead-finder/run","href":"/api-reference/lead-finder/lead-finder.run-all"},{"title":"Run one Lead Finder search","openapi":"post /api/lead-finder/{id}/run","href":"/api-reference/lead-finder/lead-finder.run-one"},{"title":"Stop the active run for one Lead Finder search without changing its future schedule","openapi":"post /api/lead-finder/{id}/stop","href":"/api-reference/lead-finder/lead-finder.stop-one"}]},{"group":"Outbound","pages":[{"title":"List Outbound","openapi":"get /api/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Get Outbound","openapi":"get /api/campaigns/{id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Create Draft Outbound","openapi":"post /api/campaigns","href":"/api-reference/campaigns/create-draft-campaign"},{"title":"Update Outbound","openapi":"patch /api/campaigns/{id}","href":"/api-reference/campaigns/update-campaign"},{"title":"Delete Campaign","openapi":"delete /api/campaigns/{id}","href":"/api-reference/campaigns/delete-campaign"},{"title":"Launch Outbound","description":"Validate and launch a draft Outbound execution.","openapi":"post /api/campaigns/{id}/launch","href":"/api-reference/campaigns/launch-campaign"},{"title":"Pause Campaign","openapi":"post /api/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Resume Campaign","description":"Restart a paused campaign. Completes pause tokens so Trigger.dev tasks continue their sequences.","openapi":"post /api/campaigns/{id}/resume","href":"/api-reference/campaigns/resume-campaign"},{"title":"List outbound sender mapping","openapi":"get /api/campaigns/mapping","href":"/api-reference/campaigns/list-outbound-sender-mapping"},{"title":"Get durable campaign message metrics","openapi":"get /api/campaigns/{id}/message-metrics","href":"/api-reference/campaigns/get-campaign-message-metrics"},{"title":"Get Senders for Campaign","openapi":"get /api/campaigns/{id}/senders","href":"/api-reference/campaigns/get-senders-for-campaign"}]},{"group":"Outbound Contacts","pages":[{"title":"Get Leads in Campaign","openapi":"get /api/campaigns/{id}/leads","href":"/api-reference/campaigns/get-leads-in-campaign"},{"title":"Add Leads to Campaign","openapi":"post /api/campaigns/{id}/leads","href":"/api-reference/campaigns/add-leads-to-campaign"},{"title":"Update Lead in Campaign","openapi":"patch /api/campaigns/{id}/leads","href":"/api-reference/campaigns/update-lead-in-campaign"},{"title":"Remove Leads from Campaign","openapi":"delete /api/campaigns/{id}/leads","href":"/api-reference/campaigns/remove-leads-from-campaign"},{"title":"Import Leads from List to Campaign","openapi":"post /api/campaigns/{id}/leads/import-from-list","href":"/api-reference/campaigns/import-leads-from-list-to-campaign"}]},{"group":"Outbound Sequence","pages":[{"title":"Add Node","openapi":"post /api/campaigns/{id}/sequence/nodes","href":"/api-reference/campaigns/add-sequence-node"},{"title":"Update Node","openapi":"put /api/campaigns/{id}/sequence/nodes/{nodeId}","href":"/api-reference/campaigns/update-sequence-node"},{"title":"Reorder Node","openapi":"patch /api/campaigns/{id}/sequence/nodes","href":"/api-reference/campaigns/move-sequence-node"},{"title":"Delete Node","openapi":"delete /api/campaigns/{id}/sequence/nodes","href":"/api-reference/campaigns/delete-sequence-node"}]},{"group":"Outbound Messages","pages":[{"title":"List Generated Messages","openapi":"get /api/campaigns/{id}/generate-messages","href":"/api-reference/campaigns/list-campaign-generated-messages"},{"title":"Generate Messages","openapi":"post /api/campaigns/{id}/generate-messages","href":"/api-reference/campaigns/generate-campaign-messages"},{"title":"Edit Generated Message","openapi":"patch /api/campaigns/{id}/generate-messages","href":"/api-reference/campaigns/update-campaign-generated-message"}]},{"group":"Outbound Settings","pages":[{"title":"Get Campaign Settings","openapi":"get /api/campaigns/settings","href":"/api-reference/campaigns/get-campaign-settings"},{"title":"Update Campaign Settings","openapi":"put /api/campaigns/settings","href":"/api-reference/campaigns/update-campaign-settings"}]},{"group":"Unibox","pages":[{"title":"Get Threads","openapi":"get /api/threads","href":"/api-reference/unibox/list-threads"},{"title":"Create Thread","openapi":"post /api/threads","href":"/api-reference/unibox/create-thread"},{"title":"Get Thread","openapi":"get /api/threads/{id}","href":"/api-reference/unibox/get-thread"},{"title":"Update Thread","openapi":"patch /api/threads/{id}","href":"/api-reference/unibox/update-thread"},{"title":"Delete Draft Thread","openapi":"delete /api/threads/{id}","href":"/api-reference/unibox/discard-draft-thread"},{"title":"Get Messages","openapi":"get /api/threads/{id}/messages","href":"/api-reference/unibox/list-thread-messages"},{"title":"Send Message","openapi":"post /api/threads/{id}/messages","href":"/api-reference/unibox/send-thread-message"}]},{"group":"Senders","pages":[{"title":"List Senders","openapi":"get /api/senders","href":"/api-reference/senders/list-senders"},{"title":"Get Sender Details","openapi":"get /api/senders/{id}","href":"/api-reference/senders/get-sender-details"},{"title":"Get Sender Schedule","openapi":"get /api/senders/{id}/schedule","href":"/api-reference/senders/get-account-schedule"}]},{"group":"Email Inboxes","pages":[{"title":"List Inboxes","openapi":"get /api/email/accounts","href":"/api-reference/senders/list-email-accounts"},{"title":"Create Inbox","openapi":"post /api/email/accounts","href":"/api-reference/senders/create-email-account"},{"title":"Update Inbox","openapi":"patch /api/email/accounts/{id}","href":"/api-reference/senders/update-email-account"},{"title":"Retry Inbox Warmup","openapi":"patch /api/email/accounts/{id}/retry-warmup","href":"/api-reference/senders/retry-account-warmup"},{"title":"Get Warmup Analytics","openapi":"get /api/email/accounts/warmup-analytics","href":"/api-reference/senders/get-warmup-analytics"},{"title":"Delete Inbox","openapi":"delete /api/email/accounts/{id}","href":"/api-reference/senders/delete-email-account"}]},{"group":"Sending Domains","pages":[{"title":"List Sending Domains","openapi":"get /api/email/domains","href":"/api-reference/senders/list-email-domains"},{"title":"Create Sending Domain","openapi":"post /api/email/domains","href":"/api-reference/senders/create-email-domain"},{"title":"Verify Domain","openapi":"post /api/email/domains/{id}/verify","href":"/api-reference/senders/verify-email-domain"},{"title":"DNS Records","openapi":"get /api/email/domains/{id}/dns-records","href":"/api-reference/senders/get-email-domain-dns-records"},{"title":"Update Domain Status","openapi":"patch /api/email/domains/{id}","href":"/api-reference/senders/update-email-domain"},{"title":"Delete Sending Domain","openapi":"delete /api/email/domains/{id}","href":"/api-reference/senders/delete-email-domain"}]},{"group":"Accounts","pages":[{"title":"Get Profile","openapi":"get /api/account","href":"/api-reference/accounts/get-account"},{"title":"Update Profile","openapi":"patch /api/account","href":"/api-reference/accounts/update-account"},{"title":"Get Company Profile","openapi":"get /api/context","href":"/api-reference/accounts/list-context"},{"title":"Update Company Profile","openapi":"put /api/context","href":"/api-reference/accounts/update-context"},{"title":"Approve onboarding section","openapi":"post /api/onboarding/approve-section","href":"/api-reference/accounts/approve-onboarding-section"},{"title":"Complete onboarding","openapi":"post /api/onboarding/complete","href":"/api-reference/accounts/complete-onboarding"}]},{"group":"Billing","pages":[{"title":"Start hosted billing checkout","openapi":"post /api/billing/checkout","href":"/api-reference/billing/billing.checkout"}]},{"group":"Discovery Pass","pages":[{"title":"Activate eligible Discovery Pass","openapi":"post /api/test-access/auto-grant","href":"/api-reference/discovery-pass/test-access.auto-grant"},{"title":"Get Discovery Pass status","openapi":"get /api/test-access","href":"/api-reference/discovery-pass/test-access.get"},{"title":"Redeem Discovery Pass code","openapi":"post /api/test-access/redeem","href":"/api-reference/discovery-pass/test-access.redeem"}]}]}]},{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/guides/agent-playbook"}]}]},"basePath":"","title":"Pause Campaign - Pixie Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}