Skip to content

Campaigns

Create, list, get, update, and manage the lifecycle of outreach campaigns.

Full name: campaignstack_list_campaigns

campaigns:read Read-only Idempotent

List campaigns in a workspace. Supports cursor-based pagination. Archived campaigns are hidden unless includeArchived is true. Use the returned campaignId values with campaignstack_get_campaign, campaignstack_list_workflows, or campaignstack_list_lead_lists.

NameTypeRequiredDefaultDescription
workspaceIdstringNoDefaults to the API key’s workspace
limitintegerNo20(min: 1, max: 100)
cursorstringNo
includeArchivedbooleanNoInclude archived campaigns. Off by default, so archived campaigns are hidden. Turn it on to find one you want to unarchive.

Full name: campaignstack_get_campaign

campaigns:read Read-only Idempotent

Get a campaign by ID with lead list count, workflow count, and ICP summary. If the campaign is not found, use campaignstack_list_campaigns to find valid campaign IDs.

NameTypeRequiredDefaultDescription
campaignIdstringYes(min length: 1)

Full name: campaignstack_create_campaign

campaigns:write

Create a new campaign in a workspace. Returns the new campaign ID and title. Creates a new campaign ready for configuration.

NameTypeRequiredDefaultDescription
workspaceIdstringNoDefaults to the API key’s workspace
titlestringYes(min length: 1)
descriptionstringNo
goalstringYes(min length: 1)

Full name: campaignstack_update_campaign

campaigns:write Idempotent

Update a campaign’s title or description. Only provided fields are updated. Returns the updated campaign object.

NameTypeRequiredDefaultDescription
campaignIdstringYes(min length: 1)
titlestringNo(min length: 1)
descriptionstringNo

Full name: campaignstack_archive_campaign

campaigns:write Destructive Idempotent

Archive a campaign. WARNING: this STOPS the campaign’s work, and the stop is one-way. Every workflow in the campaign is paused and every automation is disabled, including search watches. Unarchiving brings the campaign back but does NOT restart any of them - you have to re-enable each one deliberately. Confirm with the user before calling this. No data is deleted: leads already in flight stay parked rather than cancelled, and the campaign keeps its history. Use campaignstack_unarchive_campaign to bring it back, and campaignstack_list_campaigns with includeArchived to find archived campaigns. If the campaign is not found, use campaignstack_list_campaigns to find valid IDs.

NameTypeRequiredDefaultDescription
campaignIdstringYes(min length: 1)

Full name: campaignstack_unarchive_campaign

campaigns:write Idempotent

Unarchive a campaign, bringing it back into active views. Re-evaluates search watches. IMPORTANT: this does NOT restart the workflows and automations that archiving stopped - they stay paused and disabled, and each has to be re-enabled deliberately. That is on purpose: silently resuming outbound work as a side effect of un-hiding a campaign would start messaging real people. Use campaignstack_list_campaigns with includeArchived to find archived campaigns. If the campaign is not found, use campaignstack_list_campaigns to find valid IDs.

NameTypeRequiredDefaultDescription
campaignIdstringYes(min length: 1)

Full name: campaignstack_delete_campaign

campaigns:write Destructive

PERMANENTLY delete a campaign and cascade-delete all associated data: workflows (nodes, edges, lead contexts, webhook tokens), lead lists and entries, ICPs and lead scores, personas, phases, metrics, signal weights, topics, conversations, search cursors, scheduled automations, and enrichment queue items. This action is irreversible. Use campaignstack_archive_campaign instead to preserve data. If the campaign is not found, use campaignstack_list_campaigns to find valid IDs.

NameTypeRequiredDefaultDescription
campaignIdstringYes(min length: 1)