# Woodpecker integration

> Cold email and multichannel outreach platform API for campaigns, prospects, mailboxes, inbox replies, reports, blacklists, webhooks, domains, Lead Finder and agency client management.

- Authentication: apiKey

## Tools (105)

- **Add Campaign Step**: Appends a step to the end of a `DRAFT` or `EDITED` campaign.
- **Add Mailboxes in Bulk**: Connects up to 200 mailboxes per request with SMTP and IMAP credentials.
- **Add Microsoft Mailboxes in Bulk**: Connects Microsoft 365 mailboxes using a Graph app-only credential.
- **Add Prospects to Campaign**: Adds prospects to a campaign (creating them in the global list if needed).
- **Add Prospects to Database**: Adds prospects to the global list without enrolling them in a campaign.
- **Blacklist Agency Domains**: Agency only.
- **Blacklist Agency Emails**: Agency only.
- **Blacklist Domains**: Adds domains to the account blacklist so no campaign contacts prospects on them.
- **Blacklist Emails**: Adds email addresses to the account blacklist.
- **Check Domain Availability**: Checks availability and price for an exact list of domains with one provider.
- **Clear Bounce Shield Threshold**: Removes the threshold, which disables Bounce Shield Monitor for the campaign.
- **Collect LinkedIn Post Profiles**: Starts asynchronous collection of profiles that reacted to or commented on LinkedIn posts and saves them to a new Woodpecker list (appended name suffix ` - LinkedIn Leads`).
- **Create Agency Companies**: Agency only.
- **Create Agency Company LinkedIn Account**: Agency only.
- **Create and Run Simple Campaign**: Sends one email to one prospect from a connected mailbox, like Compose in the Woodpecker inbox.
- **Create Campaign**: Creates an email, LinkedIn, or multichannel campaign in `DRAFT` status with its sequence.
- **Create Campaign Draft**: Creates a `DRAFT` campaign with fewer required fields than Create Campaign: mailboxes, LinkedIn accounts, subject and message can be added later.
- **Create Company API Key**: Agency only.
- **Create Microsoft Graph Credential**: Saves a Microsoft Entra app registration for app-only mailbox access after verifying that Microsoft Graph issues a token for it.
- **Delete Agency Blacklisted Domains**: Agency only.
- **Delete Agency Blacklisted Emails**: Agency only.
- **Delete Agency Company Prospects**: Agency only.
- **Delete Campaign**: Permanently deletes a campaign in any status.
- **Delete Campaign Step**: Permanently deletes an `EMAIL` or `LINKEDIN` step that has processed no prospects.
- **Delete Domain**: Requests deletion of a domain, which also deletes every mailbox on it irreversibly.
- **Delete Domain Mailbox**: Requests irreversible deletion of one domain mailbox.
- **Delete Domains from Blacklist**: Removes domains from the blacklist.
- **Delete Emails from Blacklist**: Removes emails from the blacklist.
- **Delete Microsoft Graph Credential**: Deletes a credential.
- **Delete Prospects**: Deletes prospects globally (also removing them from every campaign) or only from the given campaigns.
- **Enrich LinkedIn Collected Profiles and Check Status**: Starts asynchronous enrichment of every row in a list created by LinkedIn post collection, filling Email, First name, Last name, Company, Website, Industry, Title, Tags, Address, City, State and Country where data is found.
- **Generate Agency LinkedIn Connect Link**: Agency only.
- **Generate Complete Statistics Report**: Starts a step-level report grouped by campaign, step and A/B version.
- **Generate General Statistics Report**: Starts a campaign-level report (contacted, bounced, opened, responded, interest levels), grouped by campaign and sending mailbox.
- **Generate Open Rate Report**: Starts a report of emails sent, delivered and opened, by campaign, day, mailbox, path, step and version.
- **Generate Sent Messages Report**: Starts a report of emails sent per campaign, day, path, step and version (totals across mailboxes).
- **Get Agency Blacklisted Domains**: Agency only.
- **Get Agency Blacklisted Emails**: Agency only.
- **Get Agency Deliverability Statistics**: Agency only.
- **Get Blacklisted Domains**: Lists blacklisted domains, sorted alphabetically.
- **Get Blacklisted Emails**: Lists blacklisted emails.
- **Get Bounce Shield Threshold**: Returns the Bounce Shield Monitor threshold that auto-pauses the campaign when its bounce rate reaches it.
- **Get Campaign**: Returns the full campaign structure: settings, mailboxes, and every step and version with its ids.
- **Get Campaign Statistics**: Returns one campaign with statistics.
- **Get Current Account Info**: Authentication check shown in the official docs.
- **Get Domain Details**: Returns owner, forwarding and redirect settings, readiness and mailbox summary of one purchased domain.
- **Get Domain Mailbox**: Returns one domain mailbox including SMTP and IMAP connection settings and passwords (sensitive).
- **Get Domain Owner**: Returns the saved domain owner details used to register purchased domains.
- **Get Inbox Messages**: Lists inbox replies, newest first, with cursor pagination.
- **Get Lead Finder Criterion Values**: Lists allowed values of an enumerated criterion, with substring filtering and paging.
- **Get Lead Finder Lead Enrichment**: Returns one lead enrichment batch.
- **Get Lead Finder Prospect Enrichment**: Returns the per-prospect statuses of one prospect enrichment batch.
- **Get Lead Finder Search Criteria**: Returns the current Lead Finder criteria catalog; build searches from it rather than from examples.
- **Get LinkedIn Collection Job**: Returns one collector's status.
- **Get Mailbox**: Returns one SMTP or IMAP mailbox configuration.
- **Get Mailbox Connection Batch Status**: Reports progress and failures of a bulk mailbox connection batch.
- **Get Prospect Responses**: Lists replies received from one prospect, sorted by `delivered` ascending.
- **Get Report**: Fetches a generated report.
- **Get Webhook Subscriptions**: Lists every webhook subscription in the account, regardless of which user created it.
- **Invite Company Guests**: Agency only.
- **List Agency Companies**: Agency only (Agency and API add-ons; use the HQ key).
- **List Campaign Prospects**: Lists prospects enrolled in the given campaigns with their **campaign** status.
- **List Campaigns**: Lists campaigns with basic info.
- **List Company API Keys**: Agency only.
- **List Company Email Accounts**: Agency only.
- **List Company Users**: Agency only.
- **List Domain Mailboxes**: Lists active mailboxes of a purchased domain with basic info.
- **List Domain Providers**: Lists providers for domain and mailbox orders with per-mailbox prices in the account currency.
- **List Domains**: Lists purchased domains in the account (empty array if none).
- **List Lead Finder Lead Enrichments**: Lists lead enrichment batches with per-lead state.
- **List LinkedIn Accounts**: Lists LinkedIn accounts connected to the Woodpecker account.
- **List LinkedIn Collection Jobs**: Lists post-profile collectors, newest first, 100 per page.
- **List Mailboxes**: Lists SMTP and IMAP email accounts connected to the account (empty array if none).
- **List Manual Tasks**: Lists manual tasks (call, SMS, LinkedIn, generic) created by campaigns in the account.
- **List Microsoft Graph Credentials**: Lists saved Microsoft Graph app-only credentials (client secrets are never returned).
- **List Prospects**: Lists prospects in the account with their **global** status and snippets.
- **List Users**: Lists active, confirmed users in the account, 50 per page.
- **Make Campaign Editable**: Sets the campaign status to `EDITED` so settings, steps, and content can be changed with the PATCH, step, and version endpoints.
- **Order Domain Mailboxes**: Orders extra mailboxes for domains already active in the account.
- **Order Domains**: Orders domains plus mailboxes preconfigured for cold emailing.
- **Pause Campaign**: Sets the campaign to `PAUSED` and halts contact with prospects until it is run again.
- **Query Lead Finder Prospect Enrichment Statuses**: Lists recent prospect enrichment statuses, optionally for selected emails.
- **Queue Lead Finder Lead Enrichments**: Starts an asynchronous enrichment batch for up to 50 leads from a lead search, finding emails and optionally adding the results as prospects.
- **Queue Lead Finder Prospect Enrichments**: Starts asynchronous enrichment of prospects already in the account's main prospect database, matched by email; it never creates prospects.
- **Reply to Inbox Message**: Sends an email reply to an inbox message, threaded in the same conversation, and marks the message as read.
- **Run Campaign**: Starts or resumes a campaign and sets it to `RUNNING`.
- **Save Domain Owner**: Creates or replaces the domain owner, which must exist before ordering domains.
- **Search Domain Availability**: Returns provider-generated available domain suggestions with prices for a search phrase.
- **Search Lead Finder Leads**: Searches for people matching criteria and returns compact lead records.
- **Search Prospects**: Searches prospects by field values and can attach the campaigns each belongs to.
- **Set Bounce Shield Threshold**: Sets or replaces the campaign's Bounce Shield threshold.
- **Set Domain Email Forwarding**: Forwards all mail sent to the domain's mailboxes to one address.
- **Set Domain Redirect URL**: Sets where visitors are redirected when they open the domain.
- **Stop Campaign**: Sets the campaign to `STOPPED` and halts contact with prospects until it is run again.
- **Subscribe to Webhook**: Subscribes a target URL to one event.
- **Unsubscribe from Webhook**: Removes a `target_url` and `event` subscription.
- **Update Campaign Settings**: Partially updates campaign name, mailboxes, and settings.
- **Update Campaign Step Delivery Time**: Replaces an `EMAIL` step's whole `delivery_time`; days left out are cleared.
- **Update Campaign Step Version**: Partially updates the content of one step version.
- **Update Company Guest Permissions**: Agency only.
- **Update Domain Mailbox Profile Picture**: Sets the profile picture of a domain mailbox.
- **Update Mailbox Footer**: Updates the signature (footer) appended to emails sent from an SMTP mailbox.
- **Update Microsoft Graph Credential**: Renames a credential or rotates its client secret.
- **Update Prospects in Campaign**: Updates prospects already in a campaign (status, interest level, earliest send date, snippets) and adds those that are not.
- **Update Prospects in Database**: Updates prospects in the global list by email, and adds those that do not exist.

Connect Woodpecker in General Input: https://www.generalinput.com/apps/woodpecker