SonarlyAPI Documentation

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 lead-status endpoint after start, stop, approval, or discard actions to inspect campaign-scoped workflow progress for the selected leads.

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.

GET
/v1/accounts/{accountGroupId}/campaigns

List campaigns for an account group

POST
/v1/accounts/{accountGroupId}/campaigns

Create a draft campaign from a curated starter template

DELETE
/v1/accounts/{accountGroupId}/campaigns/{campaignId}

Delete a campaign

GET
/v1/accounts/{accountGroupId}/campaigns/{campaignId}

Get a single campaign

POST
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/duplicate

Duplicate a campaign into a draft with a target audience and selected leads

GET
/v1/accounts/{accountGroupId}/campaigns/starter-templates

List curated public starter templates for campaign creation

Content slots

Inspect and update editable campaign content without exposing workflow internals.

GET
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/content-slots

List editable campaign content slots without exposing workflow definitions

PATCH
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/content-slots/{slotId}

Update the linked template for one editable campaign content slot

Execution and approvals

Start, stop, approve, discard, and inspect per-lead workflow state.

GET
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/lead-status

Get campaign workflow status for a specific set of leads

POST
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/start

Start a campaign and trigger manual workflows when required

POST
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/stop

Stop an active campaign

POST
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-instances/{workflowInstanceId}/approve

Approve pending campaign content for a workflow instance

POST
/v1/accounts/{accountGroupId}/campaigns/{campaignId}/workflow-instances/{workflowInstanceId}/discard

Discard pending campaign content for a workflow instance