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. 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

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 Idempotent

Archive a campaign (soft archive). Disables all search watch automations. The campaign and its data are preserved but removed from active views. Use campaignstack_unarchive_campaign to restore it. 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, restoring it to active status. Re-evaluates search watches. 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)