Woodpecker
App · 20 actions
Run cold email outreach in Woodpecker: add prospects and put them in campaigns, create, run, pause and stop campaigns, send one-off emails, read stats, replies and the inbox, and blacklist addresses and domains.
Actions
| Action | What it does |
|---|---|
| Add prospect | Add a prospect to your prospect list, or update one already there. |
| Add prospect to campaign | Add a prospect to a campaign (and to your prospect list if new), or update one already in it: details, status, interest level and when it may be emailed. |
| Blacklist domains | Add domains to the blacklist so no campaign emails anyone there. |
| Blacklist emails | Add email addresses to the blacklist so no campaign emails them. |
| Create campaign | Create a draft email campaign: a first email and up to 15 follow-ups in the same thread, its sending mailboxes, days and hours. |
| Delete campaign | Delete a campaign for good. |
| Delete prospects | Delete prospects from Woodpecker and every campaign, or with Campaigns set, only take them out of those campaigns. |
| Find prospects | Find prospects in your prospect list by email, company, tags or other fields, status, interest or email activity, a page at a time. |
| Get campaign | Get one campaign's status, sending mailboxes, settings and email sequence. |
| Get campaign stats | Get one campaign's numbers: prospects, sent, delivered, opened, clicked, replied, bounced and interest, plus each email step's. |
| Get prospect replies | Get a prospect's replies to campaign emails, oldest first, with the campaign and step each answered. |
| List campaign prospects | List the prospects in one campaign with their status there, optionally filtered by status, interest or email activity. |
| List campaigns | List your campaigns with their status, folder and sending mailbox, optionally only those in some statuses. |
| List inbox messages | List messages in the Woodpecker inbox, newest first: replies, bounces and autoreplies, filtered by status, interest, mailbox, campaign, text or read state. |
| List mailboxes | List the mailboxes connected to Woodpecker with their daily limit, warm-up and connection state. |
| Pause campaign | Pause a running campaign. |
| Reply to message | Reply to a message in the Woodpecker inbox from a connected mailbox. |
| Run campaign | Start a draft campaign, or resume a paused or stopped one, so it emails its prospects on schedule. |
| Send email | Send one email to one person from a Woodpecker mailbox. |
| Stop campaign | Stop a campaign. |
Add prospect
Add a prospect to your prospect list, or update one already there. Returns the prospect's id for later steps.
Inputs
- Email
emailtextRequired - The prospect's email address.
- First name
first_nametext - The prospect's first name.
- Last name
last_nametext - The prospect's last name.
- Company
companytext - The prospect's company.
- Job title
titletext - The prospect's job title.
- Website
websitetext - The prospect's or company's website.
- LinkedIn profile
linkedin_urltext - A link to the prospect's LinkedIn profile.
- Phone
phonetext - The prospect's phone number.
- Street address
addresstext - The prospect's street address.
- City
citytext - The prospect's city.
- State or region
statetext - The prospect's state, county or region.
- Country
countrytext - The prospect's country.
- Industry
industrytext - The prospect's industry.
- Tags
tagslist - Tags to add, such as webinar or q4. A # is added for you. Tags are case sensitive and can't hold spaces.
- Snippets
snippetsobject - Values for the prospect's snippets, which fill {{SNIPPET_1}} and the like in emails. Name each snippet1 to snippet15, or 1 to 15.
- Status
statustext - The prospect's status. Woodpecker uses Active when empty.One of:
ACTIVE,BOUNCED,REPLIED,BLACKLIST(Blacklisted),INVALID. - Update existing
update_existingtrue/false - Update the prospect if Woodpecker already has it. Fields left empty keep their values. Off: an existing prospect is left as it is.Default:
false. - Replace tags
replace_tagstrue/false - With 'Update existing' on, make Tags the prospect's only tags (empty clears them) instead of adding to them.Default:
false. - Import name
import_nametext - The import batch name Woodpecker shows for the prospect. Lodol is used when empty.
Outputs
duplicatetrue/false- True when the prospect was already there and 'Update existing' was off, so nothing changed
emailtext- The prospect's address
prospect_idnumber- The prospect's id
Example output
{
"duplicate": false,
"email": "jo@example.com",
"prospect_id": 98765432
}Add prospect to campaign
Add a prospect to a campaign (and to your prospect list if new), or update one already in it: details, status, interest level and when it may be emailed.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
- Email
emailtextRequired - The prospect's email address.
- First name
first_nametext - The prospect's first name.
- Last name
last_nametext - The prospect's last name.
- Company
companytext - The prospect's company.
- Job title
titletext - The prospect's job title.
- Website
websitetext - The prospect's or company's website.
- LinkedIn profile
linkedin_urltext - A link to the prospect's LinkedIn profile.
- Phone
phonetext - The prospect's phone number.
- Street address
addresstext - The prospect's street address.
- City
citytext - The prospect's city.
- State or region
statetext - The prospect's state, county or region.
- Country
countrytext - The prospect's country.
- Industry
industrytext - The prospect's industry.
- Tags
tagslist - Tags to add, such as webinar or q4. A # is added for you. Tags are case sensitive and can't hold spaces.
- Snippets
snippetsobject - Values for the prospect's snippets, which fill {{SNIPPET_1}} and the like in emails. Name each snippet1 to snippet15, or 1 to 15.
- Status in campaign
statustext - The prospect's status in this campaign. Active (the default) means it is contacted on schedule; the last four need 'Force'.One of:
ACTIVE,PAUSED,TO-REVIEW(To review),TO-CHECK(To check),BLACKLIST(Blacklisted (needs Force)),BOUNCED(Bounced (needs Force)),INVALID(Invalid (needs Force)),REPLIED(Replied (needs Force)). - Interest level
interest_leveltext - Mark how interested the prospect is. Needs 'Update existing' on.One of:
INTERESTED,MAYBE_LATER(Maybe later),NOT_INTERESTED(Not interested),NOT_MARKED(Not marked). - Send after
send_afterdate and time - The earliest time the campaign may email this prospect.
- Update existing
update_existingtrue/false - Update the prospect if Woodpecker already has it. Fields left empty keep their values. Off: an existing prospect is left as it is.Default:
false. - Force
forcetrue/false - Add the prospect even if it replied, bounced, opted out or is blacklisted elsewhere. Use with care: it may be emailed again.Default:
false. - Replace tags
replace_tagstrue/false - With 'Update existing' on, make Tags the prospect's only tags (empty clears them) instead of adding to them.Default:
false. - Import name
import_nametext - The import batch name Woodpecker shows for the prospect. Lodol is used when empty.
Outputs
already_in_campaigntrue/false- True when the prospect was already in it
already_in_prospectstrue/false- True when the prospect was already in your prospect list
campaign_idnumber- The campaign's id
emailtext- The prospect's address
prospect_idnumber- The prospect's id
Example output
{
"already_in_campaign": false,
"already_in_prospects": true,
"campaign_id": 2318840,
"email": "jo@example.com",
"prospect_id": 98765432
}Blacklist domains
Add domains to the blacklist so no campaign emails anyone there. Up to 500 at once; % matches anything, as in acme%.
Inputs
- Domains
domainslistRequired - The domains to blacklist, such as acme.com.
Outputs
countnumber- How many domains are blacklisted
domainslist- The domains now blacklisted, including any already there
Example output
{
"count": 1,
"domains": [
"example.com"
]
}Blacklist emails
Add email addresses to the blacklist so no campaign emails them. Up to 500 at once.
Inputs
- Emails
emailslistRequired - The addresses to blacklist.
Outputs
countnumber- How many addresses are blacklisted
emailslist- The addresses now blacklisted, including any already there
Example output
{
"count": 1,
"emails": [
"jo@example.com"
]
}Create campaign
Create a draft email campaign: a first email and up to 15 follow-ups in the same thread, its sending mailboxes, days and hours. Add prospects, then run it.
Inputs
- Name
nametextRequired - The campaign's name.
- Sending mailboxes
mailbox_idslistRequired - The mailboxes the campaign sends from. Pick one or more.
- Subject
subjecttextRequired - The first email's subject. Snippets such as {{FIRST_NAME}} work.
- Message
messagetextRequired - The first email, as text or HTML. Snippets such as {{FIRST_NAME}} work.
- Follow-up messages
follow_up_messageslist - Up to 15 follow-ups, in order, each sent in the same thread if the prospect hasn't replied.
- Days between emails
follow_up_after_daysnumber - Days to wait before each follow-up, 1 to 9999.From 1 to 9999. Default:
3. - Sending days
send_dayslist - The days emails may go out. Monday to Friday when empty.One or more of:
MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY. Default:["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"]. - Send from
send_fromtime - The time of day sending starts, 08:00 when empty.
- Send until
send_totime - The time of day sending stops, 18:00 when empty.
- Time zone
time_zonetext - The time zone of the sending hours, such as Europe/London. UTC when empty.
- New prospects a day
daily_enrollnumber - How many new prospects the campaign starts on each day, 1 to 500.From 1 to 500. Default:
100. - Track opens
track_openstrue/false - Track when prospects open the emails.Default:
false. - Include signature
include_signaturetrue/false - Add the sending mailbox's signature to each email.Default:
true. - Use prospect's time zone
use_prospect_timezonetrue/false - Send in each prospect's own time zone instead of the campaign's.Default:
false.
Outputs
campaignobject- The new campaign
Example output
{
"campaign": {
"bounce_shield_autopaused_at": null,
"email_account_ids": [
112233
],
"id": 2318840,
"name": "Q4 founders outreach",
"settings": {
"auto_pause_prospect_from_domain_statuses": [
"REPLIED"
],
"catch_all_verification_mode": "BALANCED",
"count_followup_delay_in_working_days": false,
"daily_enroll": 100,
"gdpr_unsubscribe": false,
"list_unsubscribe": false,
"open_disabled_list": [],
"prospect_timezone": false,
"timezone": "Europe/London"
},
"status": "DRAFT",
"steps": {
"followup": {
"body": {
"versions": [
{
"id": 601,
"message": "<p>Hi {{FIRST_NAME}}</p>",
"signature": "SENDER",
"subject": "Quick question",
"track_opens": false,
"version": "A"
}
]
},
"followup": null,
"id": 502,
"type": "EMAIL"
},
"id": 501,
"type": "START"
}
}
}Delete campaign
Delete a campaign for good. Woodpecker can't restore it; its prospects stay in your prospect list.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaign_idnumber- The deleted campaign's id
deletedtrue/false- True once the campaign is deleted
Example output
{
"campaign_id": 2318840,
"deleted": true
}Delete prospects
Delete prospects from Woodpecker and every campaign, or with Campaigns set, only take them out of those campaigns.
Inputs
- Prospect IDs
prospect_idslistRequired - The prospects to delete, by id. Up to 300.
- Only from campaigns
campaign_idslist - Only take the prospects out of these campaigns. Empty deletes them from Woodpecker altogether.
Outputs
campaign_idslist- The campaigns they were taken out of; empty when deleted everywhere
countnumber- How many prospects were deleted
prospect_idslist- The prospects deleted
Example output
{
"campaign_ids": [],
"count": 1,
"prospect_ids": [
98765432
]
}Find prospects
Find prospects in your prospect list by email, company, tags or other fields, status, interest or email activity, a page at a time.
Inputs
- Email
emailtext - Find by email. A full address matches exactly; part of one matches every address containing it.
- Search fields
searchobject - More to match, as a field and the text to find: company, first_name, last_name, title, tags, industry, website, city, state, country, phone, address or snippet1 to snippet15. All must match.
- Prospect IDs
prospect_idslist - Only these prospects, by id.
- Status
statustext - Only prospects with this status.One of:
ACTIVE,BOUNCED,REPLIED,BLACKLIST(Blacklisted),INVALID. - Contacted
contactedtext - Only prospects a campaign has emailed, or only those it hasn't yet.One of:
CONTACTED,NOT_CONTACTED(Not contacted yet). - Interest level
interest_leveltext - Only prospects whose reply is marked with this interest level.One of:
INTERESTED,MAYBE_LATER(Maybe later),NOT_INTERESTED(Not interested),NOT_MARKED(Not marked). - Email activity
activitytext - Only prospects who opened or clicked, or who didn't.One of:
OPENED,NOT-OPENED(Not opened),CLICKED,NOT-CLICKED(Not clicked). - Include campaigns
include_campaignstrue/false - Also list the campaigns each prospect is in, with its status there.Default:
false. - Sort by
sort_bytext - The field to sort by. Woodpecker's own order is used when empty.One of:
updated(Last updated),id(Order added),email,first_name(First name),last_name(Last name),company,last_contacted(Last contacted),last_replied(Last replied). - Newest or highest first
sort_descendingtrue/false - Sort from the latest date or the end of the alphabet.Default:
false. - Page
pagenumber - Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.
- Per page
per_pagenumber - How many prospects a page holds, 1 to 1000. Woodpecker's default is 100.From 1 to 1000.
Outputs
countnumber- How many prospects are on this page
next_pagenumber- Pass as 'page' for the next page; empty on the last one
pagenumber- This page's number, from 1
per_pagenumber- The page size
prospectslist- The prospects
totalnumber- How many prospects match in all
Example output
{
"count": 1,
"next_page": null,
"page": 1,
"per_page": 100,
"prospects": [
{
"address": null,
"campaign_id": null,
"campaigns": [
{
"campaign_id": 2318840,
"campaign_name": "Q4 founders outreach",
"campaign_prospect_status": "ACTIVE",
"campaign_status": "RUNNING",
"interest_level": null
}
],
"city": "London",
"click_url": null,
"company": "Example Ltd",
"country": "United Kingdom",
"email": "jo@example.com",
"first_name": "Jo",
"id": 98765432,
"industry": "Software",
"interest_level": null,
"last_clicked": null,
"last_contacted": "2026-10-02T10:15:00+0200",
"last_name": "Bloggs",
"last_open": null,
"last_replied": null,
"linkedin_url": null,
"phone": null,
"sent_mails": null,
"snippets": {
"snippet1": "your new office"
},
"state": null,
"status": "ACTIVE",
"tags": "#founders #q4",
"title": "Founder",
"updated": "2026-10-02T10:15:00+0200",
"website": "https://example.com"
}
],
"total": 1
}Get campaign
Get one campaign's status, sending mailboxes, settings and email sequence.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaignobject- The campaign
Example output
{
"campaign": {
"bounce_shield_autopaused_at": null,
"email_account_ids": [
112233
],
"id": 2318840,
"name": "Q4 founders outreach",
"settings": {
"auto_pause_prospect_from_domain_statuses": [
"REPLIED"
],
"catch_all_verification_mode": "BALANCED",
"count_followup_delay_in_working_days": false,
"daily_enroll": 100,
"gdpr_unsubscribe": false,
"list_unsubscribe": false,
"open_disabled_list": [],
"prospect_timezone": false,
"timezone": "Europe/London"
},
"status": "DRAFT",
"steps": {
"followup": {
"body": {
"versions": [
{
"id": 601,
"message": "<p>Hi {{FIRST_NAME}}</p>",
"signature": "SENDER",
"subject": "Quick question",
"track_opens": false,
"version": "A"
}
]
},
"followup": null,
"id": 502,
"type": "EMAIL"
},
"id": 501,
"type": "START"
}
}
}Get campaign stats
Get one campaign's numbers: prospects, sent, delivered, opened, clicked, replied, bounced and interest, plus each email step's.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaignobject- The campaign
email_stepslist- Each email step's subject, message and numbers (the first version only)
statsobject- The campaign's numbers
Example output
{
"campaign": {
"created": "2026-10-01T09:00:00+0200",
"folder_id": 0,
"folder_name": "UNASSIGNED",
"from_email": "sam@acme.com",
"from_emails": [
"sam@acme.com"
],
"from_name": "Sam Lee",
"id": 2318840,
"name": "Q4 founders outreach",
"per_day": 50,
"status": "RUNNING"
},
"email_steps": [
{
"emailSend": 98,
"open": "55.1%",
"reply": "11.2%",
"step": 1,
"subject": "Quick question"
}
],
"stats": {
"autoreplied": 3,
"bounced": 1,
"check": 0,
"clicked": 9,
"delivery": 96,
"interested": 4,
"invalid": 2,
"maybe_later": 2,
"not_interested": 3,
"opened": 54,
"optout": 1,
"prospects": 120,
"queue": 20,
"replied": 11,
"sent": 98
}
}Get prospect replies
Get a prospect's replies to campaign emails, oldest first, with the campaign and step each answered.
Inputs
- Prospect ID
prospect_idtextRequired - The prospect's id, from 'Add prospect', 'Find prospects' or an earlier step.
- Campaigns
campaign_idslist - Only these campaigns. Leave empty for all of them.
Outputs
countnumber- How many replies there are
emailtext- The prospect's address
prospect_idnumber- The prospect's id
responseslist- The replies
Example output
{
"count": 1,
"email": "jo@example.com",
"prospect_id": 98765432,
"responses": [
{
"campaign_email_sent": "2026-10-02T10:15:00",
"campaign_id": 2318840,
"delivered": "2026-10-03T10:30:00",
"delivered_utc": "2026-10-03T08:30:00Z",
"message": "Sounds good, let's talk.",
"response_id": 778899,
"secondary_prospect_email": null,
"step": 1,
"subject": "Re: Quick question"
}
]
}List campaign prospects
List the prospects in one campaign with their status there, optionally filtered by status, interest or email activity.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
- Status in campaign
statustext - Only prospects with this status in the campaign.One of:
ACTIVE,TO-CHECK(To check),TO-REVIEW(To review),PAUSED,REPLIED,AUTOREPLIED,BOUNCED,BLACKLIST(Blacklisted),INVALID. - Contacted
contactedtext - Only prospects a campaign has emailed, or only those it hasn't yet.One of:
CONTACTED,NOT_CONTACTED(Not contacted yet). - Interest level
interest_leveltext - Only prospects whose reply is marked with this interest level.One of:
INTERESTED,MAYBE_LATER(Maybe later),NOT_INTERESTED(Not interested),NOT_MARKED(Not marked). - Email activity
activitytext - Only prospects who opened or clicked, or who didn't.One of:
OPENED,NOT-OPENED(Not opened),CLICKED,NOT-CLICKED(Not clicked). - Sort by
sort_bytext - The field to sort by. Woodpecker's own order is used when empty.One of:
updated(Last updated),id(Order added),email,first_name(First name),last_name(Last name),company,last_contacted(Last contacted),last_replied(Last replied). - Newest or highest first
sort_descendingtrue/false - Sort from the latest date or the end of the alphabet.Default:
false. - Page
pagenumber - Which page to get, starting at 1. Use 'next_page' from the last one.At least 1.
- Per page
per_pagenumber - How many prospects a page holds, 1 to 1000. Woodpecker's default is 100.From 1 to 1000.
Outputs
countnumber- How many prospects are on this page
next_pagenumber- Pass as 'page' for the next page; empty on the last one
pagenumber- This page's number, from 1
per_pagenumber- The page size
prospectslist- The prospects in the campaign
totalnumber- How many prospects match in all
Example output
{
"count": 1,
"next_page": null,
"page": 1,
"per_page": 100,
"prospects": [
{
"address": null,
"campaign_id": 2318840,
"campaign_name": "Q4 founders outreach",
"campaign_status": "RUNNING",
"city": "London",
"click_url": null,
"company": "Example Ltd",
"country": "United Kingdom",
"email": "jo@example.com",
"first_name": "Jo",
"id": 98765432,
"industry": "Software",
"interest_level": {
"ai_detected": true,
"level": "INTERESTED"
},
"last_clicked": null,
"last_contacted": "2026-10-02T10:15:00+0200",
"last_name": "Bloggs",
"last_open": null,
"last_replied": null,
"linkedin_url": null,
"phone": null,
"sent_mails": 2,
"snippets": {
"snippet1": "your new office"
},
"state": null,
"status": "ACTIVE",
"tags": "#founders #q4",
"title": "Founder",
"updated": "2026-10-02T10:15:00+0200",
"website": "https://example.com"
}
],
"total": 1
}List campaigns
List your campaigns with their status, folder and sending mailbox, optionally only those in some statuses.
Inputs
- Statuses
statuseslist - Only campaigns in these statuses. All when empty.One or more of:
RUNNING,DRAFT,EDITED(Being edited),PAUSED,STOPPED,COMPLETED.
Outputs
campaignslist- The campaigns
countnumber- How many campaigns were found
Example output
{
"campaigns": [
{
"created": "2026-10-01T09:00:00+0200",
"folder_id": 0,
"folder_name": "UNASSIGNED",
"from_email": "sam@acme.com",
"from_emails": [
"sam@acme.com"
],
"from_name": "Sam Lee",
"id": 2318840,
"name": "Q4 founders outreach",
"per_day": 50,
"status": "RUNNING"
}
],
"count": 1
}List inbox messages
List messages in the Woodpecker inbox, newest first: replies, bounces and autoreplies, filtered by status, interest, mailbox, campaign, text or read state.
Inputs
- Prospect status
prospect_statustext - Only messages from prospects with this status. Use one of this, Interest level or Without prospect.One of:
RESPONDED,AUTOREPLIED,BOUNCED,BLACKLISTED,OPT_OUT(Opted out). - Interest level
interest_leveltext - Only messages marked with this interest level.One of:
INTERESTED,MAYBE_LATER(Maybe later),NOT_INTERESTED(Not interested),NOT_MARKED(Not marked). - Without prospect
without_prospecttrue/false - Only messages from senders who aren't prospects.Default:
false. - Mailboxes
mailbox_idslist - Only messages that reached these receiving mailboxes.
- Campaigns
campaign_idslist - Only these campaigns. Leave empty for all of them.
- Search
searchlist - Up to 20 phrases to look for, each at least 3 characters.
- Read or unread
read_statetext - Only read messages, or only unread ones. Both when empty.One of:
READ,UNREAD. - Per page
per_pagenumber - How many messages to get, 1 to 50. Woodpecker's default is 10.From 1 to 50.
- Page cursor
page_cursortext - For the next page: the 'next_page_cursor' of the last one.
Outputs
countnumber- How many messages are on this page
messageslist- The messages
next_page_cursortext- Pass as 'Page cursor' for the next page; empty on the last one
previous_page_cursortext- The cursor of the page before this one
Example output
{
"count": 1,
"messages": [
{
"body_html": "<p>Sounds good, let's talk.</p>",
"bounced": false,
"campaigns": [
{
"id": 2318840,
"name": "Q4 founders outreach"
}
],
"cc": [],
"from_email": "jo@example.com",
"from_name": "Jo Bloggs",
"global_prospect_status": "REPLIED",
"id": 123456,
"mailbox_id": 445566,
"not_found": false,
"prospect_id": 98765432,
"read": false,
"recipient": "sam@acme.com",
"stamp": "2026-10-03T08:30:00Z",
"subject": "Re: Quick question"
}
],
"next_page_cursor": null,
"previous_page_cursor": null
}List mailboxes
List the mailboxes connected to Woodpecker with their daily limit, warm-up and connection state.
Inputs
- Type
mailbox_typetext - Only sending (SMTP) or only receiving (IMAP) mailboxes.One of:
SMTP(Sending (SMTP)),IMAP(Receiving (IMAP)).
Outputs
countnumber- How many mailboxes were found
mailboxeslist- The mailboxes
Example output
{
"count": 1,
"mailboxes": [
{
"daily_limit": 50,
"email": "sam@acme.com",
"error": null,
"from_name": "Sam Lee",
"id": 112233,
"imap_id": 445566,
"provider": "GOOGLE",
"reconnect_required": false,
"sent_today": 12,
"type": "SMTP",
"warmup_status": "RUNNING"
}
]
}Pause campaign
Pause a running campaign. 'Run campaign' resumes it.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaign_idnumber- The campaign's id
statustext- The campaign's status after the step
Example output
{
"campaign_id": 2318840,
"status": "PAUSED"
}Reply to message
Reply to a message in the Woodpecker inbox from a connected mailbox. It marks the message read.
Inputs
- Message ID
message_idtextRequired - The inbox message to answer, from 'List inbox messages'.
- Reply
messagetextRequired - The reply, as text or HTML.
- Send from
mailbox_idtext - The mailbox to reply from. The one that received the message when empty.
- To
totext - Send to this address instead of the sender.
- CC
cclist - Addresses to copy in.
- BCC
bcclist - Addresses to copy in unseen. The mailbox's own BCC setting when empty.
- Subject
subjecttext - The subject. Re: and the original subject when empty.
- Quote original
quote_original_messagetrue/false - Quote the message being answered under the reply.Default:
false. - Include signature
include_signaturetrue/false - Add the sending mailbox's signature.Default:
false.
Outputs
message_idnumber- The message answered
senttrue/false- True once Woodpecker has passed the reply to the mailbox
Example output
{
"message_id": 123456,
"sent": true
}Run campaign
Start a draft campaign, or resume a paused or stopped one, so it emails its prospects on schedule.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaign_idnumber- The campaign's id
statustext- The campaign's status after the step
Example output
{
"campaign_id": 2318840,
"status": "RUNNING"
}Send email
Send one email to one person from a Woodpecker mailbox. Woodpecker makes it a one-step campaign that starts at once, within the mailbox's sending limits.
Inputs
- Mailbox
mailbox_idtextRequired - The sending mailbox. Pick one, or give its id from an earlier step.
- To
totextRequired - The recipient's email address. Woodpecker adds them as a prospect if they aren't one.
- Subject
subjecttextRequired - The email's subject.
- Message
messagetextRequired - The email, as text or HTML. Snippets such as {{FIRST_NAME}} work. The mailbox footer isn't added.
- Track opens
track_openstrue/false - Track when the recipient opens the email.Default:
false. - CC
cctext - One address to copy in.
- BCC
bcctext - One address to copy in without the recipient seeing it.
Outputs
campaignobject- The one-step campaign that sends the email
prospect_emailtext- The recipient's address
Example output
{
"campaign": {
"bounce_shield_autopaused_at": null,
"email_account_ids": [
112233
],
"id": 2318840,
"name": "My Campaign",
"settings": {
"auto_pause_prospect_from_domain_statuses": [
"REPLIED"
],
"catch_all_verification_mode": "BALANCED",
"count_followup_delay_in_working_days": false,
"daily_enroll": 100,
"gdpr_unsubscribe": false,
"list_unsubscribe": false,
"open_disabled_list": [],
"prospect_timezone": false,
"timezone": "Europe/London"
},
"status": "RUNNING",
"steps": {
"followup": {
"body": {
"versions": [
{
"id": 601,
"message": "<p>Hi {{FIRST_NAME}}</p>",
"signature": "SENDER",
"subject": "Quick question",
"track_opens": false,
"version": "A"
}
]
},
"followup": null,
"id": 502,
"type": "EMAIL"
},
"id": 501,
"type": "START"
}
},
"prospect_email": "jo@example.com"
}Stop campaign
Stop a campaign. 'Run campaign' starts it again.
Inputs
- Campaign
campaign_idtextRequired - The campaign. Pick one, or give its id from an earlier step.
Outputs
campaign_idnumber- The campaign's id
statustext- The campaign's status after the step
Example output
{
"campaign_id": 2318840,
"status": "STOPPED"
}