> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Woodpecker Co

> Woodpecker.co is a cold email tool that automates personalized email outreach and follow-ups for sales teams and agencies.

![Woodpecker Co logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/woodpecker_co.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=e7ff05ec478d07e6e8f8731dcac5e58d)

* **Category:** drip emails
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `WOODPECKER_CO`
* **Version:** 20261101\_00

## Tools

> [accordion] Add prospects to a campaign (v1)
>
> **Slug:** `WOODPECKER_CO_ADD_PROSPECTS_TO_CAMPAIGN_V1`
>
> Add one or multiple prospects to a campaign's contact list. New prospects are also added to the global prospect list; forcing non-active prospects may allow them to be contacted again.
>
> #### Input Parameters
>
> **force** `boolean`
>
> If true, adds prospects regardless of their global status
>
> **campaign** `object` *required*
>
> Campaign data specifying which campaign to add to
>
> **file\_name** `string`
>
> Name of the import batch (visible in the "imported" column)
>
> **prospects** `array` *required*
>
> List of prospects to add (max 20000 per request)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Campaign Step
>
> **Slug:** `WOODPECKER_CO_DELETE_CAMPAIGN_STEP`
>
> Tool to delete a non-initial campaign step that hasn't processed any prospects. Use when the campaign is in DRAFT or EDITED status and the step is unused.
>
> #### Input Parameters
>
> **step\_id** `string` *required*
>
> The UUID of the step to delete. Must be a non-initial step (not the START step or first step after START) that has not processed any prospects. Use the Get Campaign action to retrieve step IDs.
>
> **campaign\_id** `integer` *required*
>
> The unique identifier of the campaign containing the step to delete. Use the List Campaigns action to retrieve available campaign IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Prospects in Campaigns (v1)
>
> **Slug:** `WOODPECKER_CO_GET_PROSPECTS_IN_CAMPAIGNS_V1`
>
> Retrieve a page of prospects enrolled in specified Woodpecker campaigns, including campaign status and prospect details. Filter by prospect IDs, campaign status, contact status, interest or activity, and use sorting and pagination to narrow the results; up to 1,000 records can be requested per page.
>
> #### Input Parameters
>
> **id** `array`
>
> Filter to specific prospect IDs. Only prospects with these IDs will be returned.
>
> **diff** `string`
>
> ISO-8601-like timestamp to filter by activity date (requires corresponding activity parameter).
>
> **page** `integer`
>
> 1-based page number for pagination.
>
> **sort** `string`
>
> Comma-separated sort fields with '+' for asc or '-' for desc (e.g., '+company,-last\_contacted').
>
> **status** `string ("ACTIVE" | "BOUNCED" | "TO-CHECK" | "TO-REVIEW" | "REPLIED" | "AUTOREPLIED" | "BLACKLIST" | "PAUSED" | "INVALID")`
>
> Filter by prospect's status within the campaign (e.g., ACTIVE, REPLIED, BOUNCED).
>
> **activity** `string ("OPENED" | "NOT-OPENED" | "CLICKED" | "NOT-CLICKED")`
>
> Activity filter.
>
> **per\_page** `integer`
>
> Number of results per page (default 100, max 1000).
>
> **contacted** `boolean`
>
> Whether prospect was contacted in those campaigns.
>
> **interested** `string ("INTERESTED" | "MAYBE-LATER" | "NOT-INTERESTED" | "NOT-MARKED")`
>
> Interest level filter.
>
> **campaigns\_id** `array` *required*
>
> List of campaign IDs to retrieve prospects from. At least one campaign ID is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Available Webhook Events
>
> **Slug:** `WOODPECKER_CO_LIST_AVAILABLE_WEBHOOK_EVENTS`
>
> List a static catalog of Woodpecker webhook event names. The catalog is not exhaustive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns V1
>
> **Slug:** `WOODPECKER_CO_LIST_CAMPAIGNS_V1`
>
> List campaigns with optional status or ID filters. Certain authentication or permission failures are returned as an empty campaign list.
>
> #### Input Parameters
>
> **id** `array`
>
> Optional list of campaign IDs to filter by. Providing a single ID may return detailed information for that campaign.
>
> **status** `array`
>
> Optional list of campaign statuses to filter by. Allowed values: RUNNING, DRAFT, EDITED, PAUSED, STOPPED, COMPLETED.
>
> **company\_id** `integer`
>
> Agency HQ only: client company context to act on. Sent as x-company-id header when provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause Campaign
>
> **Slug:** `WOODPECKER_CO_PAUSE_CAMPAIGN`
>
> Tool to pause a campaign. Use when you need to temporarily stop sending prospects until resumed.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Unique identifier of the campaign to pause. Must be a positive integer. Use 'List Campaigns' action to get available campaign IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Campaign
>
> **Slug:** `WOODPECKER_CO_RUN_CAMPAIGN`
>
> Request to start a configured Woodpecker campaign and set its status to RUNNING. Enrolled prospects are processed according to the campaign's settings and delivery times; check the campaign status to confirm it started.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Unique identifier of the campaign to run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop Campaign
>
> **Slug:** `WOODPECKER_CO_STOP_CAMPAIGN`
>
> Stop a Woodpecker campaign by ID, setting its status to STOPPED and halting further prospect contact. The campaign can be resumed using the run operation.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> The unique numeric identifier of the campaign to stop. Obtain this value from the List Campaigns endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
