Available tools

Campaign management

createCampaign

Create campaigns with basic configuration including subjects, messages and delivery settings. Supports full templating with snippets, fallbacks and spintax for personalized content.

Parameter	Type	Description
name	string	Campaign name
subjects	array	Email subject lines
messages	array	Email body content
emailAccountIds	array	SMTP account IDs
timezone	string	Campaign timezone
dailyEnroll	integer	Daily prospect enrollment limit
deliveryDays	array	Days of the week for sending
deliveryTimeStart/Stop	string	Sending time window
trackOpens	boolean	Enable open tracking

createAdvancedCampaign

Create campaigns with full API capabilities including A/B testing and complex delivery schedules.

Parameter	Type	Description
campaignPayload	string	Complete campaign configuration JSON

listCampaigns

Retrieve campaigns with optional status filtering.

Parameter	Type	Description
pageNumber	integer	Page number (1-based)
statuses	array	Filter by status (RUNNING, DRAFT, PAUSED, STOPPED, COMPLETED)

retrieveCampaignDetails

Get detailed campaign structure including all steps and configurations.

Parameter	Type	Description
campaignId	integer	Campaign ID

retrieveCampaignStatistics

Fetch campaign performance metrics and analytics.

Parameter	Type	Description
campaignId	integer	Campaign ID

updateCampaignSettings

Modify campaign-wide settings including name, email accounts, daily limits and timezone.

Parameter	Type	Description
campaignId	number	Campaign ID
name	string	Campaign name
emailAccountIds	array	List of email account IDs
timezone	string	Campaign timezone
dailyEnroll	number	Daily enrollment limit

buildCampaignUrl

Generate Woodpecker app URL for campaign access.

Parameter	Type	Description
campaignId	integer	Campaign ID

Campaign control

runCampaign(campaignId) - Start campaign execution

pauseCampaign(campaignId) - Pause campaign

stopCampaign(campaignId) - Stop campaign

deleteCampaign(campaignId) - Remove campaign entirely

makeCampaignEditable(campaignId) - Enable campaign modifications

Email step management

addStep

Add follow-up steps to existing campaigns.

Parameter	Type	Description
campaignId	integer	Campaign ID
payload	string	Step configuration JSON

updateCampaignStep

Modify step delivery times and scheduling.

Parameter	Type	Description
campaignId	integer	Campaign ID
stepId	string	Step ID
payload	string	Updated delivery configuration

updateStepVersion

Update email content, subject lines, signatures and tracking settings.

Parameter	Type	Description
campaignId	integer	Campaign ID
stepId	string	Step ID
versionId	string	Version ID
subject	string	Email subject
message	string	Email body (HTML supported)
signature	string	SENDER or NO_SIGNATURE
trackOpens	boolean	Enable open tracking

deleteCampaignStep

Remove steps from campaigns.

Parameter	Type	Description
campaignId	integer	Campaign ID
stepId	string	Step ID

Prospect management

addProspectsToCampaign

Bulk add prospects with full contact information and custom snippets.

Parameter	Type	Description
campaignId	integer	Campaign ID
prospectsPayload	string	Array of prospect objects

Note: Always check for DUPLICATE prospects in response. Use updateProspectsInCampaign for duplicates if data updates are needed.

updateProspectsInCampaign

Update existing prospect data (requires explicit user request).

Parameter	Type	Description
campaignId	integer	Campaign ID
prospectsPayload	string	Array of prospect objects

listProspectsInCampaign

Paginated retrieval of campaign prospects.

Parameter	Type	Description
campaignId	integer	Campaign ID
pageNumber	integer	Page number (1-based)

Account management

listMailboxes

Retrieve available email accounts for campaign assignment.

Parameters: None