API Reference
Campaigns
Create, duplicate, inspect, approve, start, and stop outreach campaigns.
Public campaign boundary
The API exposes campaign metadata, starter-template drafts, duplication, content-slot updates, approvals, and lifecycle controls without exposing internal workflow-template authoring.
Workflow state
Use the workflow-run approval endpoint to review pending messages before mutation, then use lead-status after start, stop, approval, or discard actions to inspect campaign-scoped workflow progress for selected leads. Discard is terminal for that run.
Changing generated content
Generated campaign messages are edited by PATCHing workflow-run messages before approving the run. Use message for DM/InMail/comment text, subject for InMail or email subjects, and requestMessage for connection-request invite notes.
Metadata-only list
The campaign list endpoint returns metadata only. It does not include workflow-builder nodes, step content, raw workflow graphs, or authoring data.
Campaign setup
Create, duplicate, list, inspect, and delete campaign drafts and starter templates.
/v1/accounts/{accountGroupId}/campaignsList campaigns for an account group
/v1/accounts/{accountGroupId}/campaignsCreate a draft campaign from a curated starter template
/v1/accounts/{accountGroupId}/campaigns/{campaignId}Delete a campaign
/v1/accounts/{accountGroupId}/campaigns/{campaignId}Get a single campaign
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/duplicateDuplicate a campaign into a draft with a target audience and selected leads
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/scheduleUpdate a campaign schedule
/v1/accounts/{accountGroupId}/campaigns/starter-templatesList curated public starter templates for campaign creation
Content slots
Inspect and update editable campaign content without exposing workflow internals.
Execution and approvals
Start, stop, approve, discard, and inspect per-lead workflow state.
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/lead-statusGet campaign workflow status for a specific set of leads
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/startStart a campaign and trigger manual workflows when required
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/stopStop an active campaign
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-instances/{workflowInstanceId}/approveApprove pending campaign content (legacy)
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-instances/{workflowInstanceId}/content-approvalGet one campaign content approval
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-instances/{workflowInstanceId}/discardDiscard pending campaign content (legacy)
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-runs/{workflowInstanceId}/approvalGet one campaign run approval
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-runs/{workflowInstanceId}/approveApprove a campaign run
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-runs/{workflowInstanceId}/discardDiscard a campaign run
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-runs/{workflowInstanceId}/messagesUpdate campaign run messages
/v1/accounts/{accountGroupId}/campaigns/content-approvalsList campaign content needing approval