> ## 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.

# Heyreach

> HeyReach is a multichannel outreach platform designed to help businesses and professionals engage with their audience effectively.

![Heyreach logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/heyreach.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=0bff9d6a5b8fbd99140749e15951f634)

* **Category:** marketing automation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 21
* **Triggers:** 0
* **Slug:** `HEYREACH`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Leads To List V2
>
> **Slug:** `HEYREACH_ADD_LEADS_TO_LIST_V2`
>
> Tool to add leads to a lead list in HeyReach for LinkedIn campaigns. Accepts up to 100 leads per request and returns counts of added, updated, and failed leads.
>
> #### Input Parameters
>
> **leads** `array` *required*
>
> Array of lead objects to add. Maximum 100 leads per request.
>
> **listId** `integer` *required*
>
> The ID of the list to add leads to. Must be an existing list ID.
>
> #### 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] Check API Key
>
> **Slug:** `HEYREACH_CHECK_API_KEY`
>
> Tool to check if the API key is valid. Use before making other API calls to confirm authentication.
>
> #### 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] Create Empty List
>
> **Slug:** `HEYREACH_CREATE_EMPTY_LIST`
>
> Tool to create an empty list. Use after deciding on the list name and type.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the list to create.
>
> **type** `string ("COMPANY_LIST" | "USER_LIST")`
>
> The type of list to create. Use 'USER\_LIST' for leads and 'COMPANY\_LIST' for companies. Defaults to 'USER\_LIST'.
>
> #### 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] Create Tags
>
> **Slug:** `HEYREACH_CREATE_TAGS`
>
> Tool to create one or multiple tags for your workspace. Use when you need to organize leads with custom labels.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Array of tag objects to create. Each tag must have a displayName and color.
>
> #### 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] Create Webhook
>
> **Slug:** `HEYREACH_CREATE_WEBHOOK`
>
> Tool to create a new webhook. Use when you need programmatic callbacks for HeyReach events after confirming a valid API key.
>
> #### Input Parameters
>
> **eventType** `string ("CONNECTION_REQUEST_SENT" | "CONNECTION_REQUEST_ACCEPTED" | "MESSAGE_SENT" | "MESSAGE_REPLY_RECEIVED" | "INMAIL_SENT" | "INMAIL_REPLY_RECEIVED" | "FOLLOW_SENT" | "LIKED_POST" | "VIEWED_PROFILE" | "CAMPAIGN_COMPLETED" | "LEAD_TAG_UPDATED")` *required*
>
> Type of event that triggers the webhook.
>
> **webhookUrl** `string` *required*
>
> Destination URL where HeyReach will send POST event payloads.
>
> **campaignIds** `array`
>
> List of campaign IDs to filter events. If empty, listens for the eventType across all campaigns.
>
> **webhookName** `string` *required*
>
> Descriptive name for the webhook, used for identification. Maximum 25 characters.
>
> #### 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 Webhook
>
> **Slug:** `HEYREACH_DELETE_WEBHOOK`
>
> Tool to delete an existing webhook. Use when you need to remove callbacks for outdated or unwanted webhooks.
>
> #### Input Parameters
>
> **webhookId** `string` *required*
>
> Unique identifier of the webhook to delete.
>
> #### 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 All Campaigns
>
> **Slug:** `HEYREACH_GET_ALL_CAMPAIGNS`
>
> Tool to retrieve all campaigns. Use when you need a paginated list of campaigns for management or reporting.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of campaigns to return (1-100)
>
> **offset** `integer`
>
> Number of campaigns to skip
>
> **keyword** `string`
>
> Keyword to filter campaigns by name
>
> **statuses** `array`
>
> Filter campaigns by statuses, e.g., \['DRAFT','PAUSED']
>
> **accountIds** `array`
>
> Filter campaigns by LinkedIn account 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 All Leads
>
> **Slug:** `HEYREACH_GET_ALL_LEADS`
>
> Tool to retrieve all leads in a HeyReach list. Use when you need paginated collection of leads after confirming a valid API key.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of records to return, between 1 and 1000.
>
> **listId** `integer` *required*
>
> The ID of the lead list.
>
> **offset** `integer`
>
> The number of records to skip for pagination.
>
> **keyword** `string`
>
> Search term to filter leads by name or other relevant fields.
>
> **createdTo** `string`
>
> ISO 8601 end date for filtering leads by creation time.
>
> **createdFrom** `string`
>
> ISO 8601 start date for filtering leads by creation time.
>
> **leadLinkedInId** `string`
>
> LinkedIn ID to filter leads.
>
> **leadProfileUrl** `string`
>
> LinkedIn profile URL to filter leads.
>
> #### 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 All LinkedIn Accounts
>
> **Slug:** `HEYREACH_GET_ALL_LINKEDIN_ACCOUNTS`
>
> Tool to retrieve all LinkedIn accounts. Use when you need a paginated list of LinkedIn accounts after confirming a valid API key.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of accounts to return (1-100)
>
> **offset** `integer`
>
> Number of accounts to skip
>
> **keyword** `string`
>
> Keyword to filter accounts by name
>
> #### 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 All Lists
>
> **Slug:** `HEYREACH_GET_ALL_LISTS`
>
> Tool to retrieve all lists. Use when you need a paginated list of lists after confirming a valid API key.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of lists to return.
>
> **offset** `integer`
>
> Number of lists to skip for pagination.
>
> #### 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 All Webhooks
>
> **Slug:** `HEYREACH_GET_ALL_WEBHOOKS`
>
> Tool to retrieve all webhooks. Use when you need a paginated collection of webhooks after confirming a valid API key.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of webhooks to return
>
> **offset** `integer`
>
> Number of webhooks to skip for pagination
>
> #### 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 Companies From List
>
> **Slug:** `HEYREACH_GET_COMPANIES_FROM_LIST`
>
> Tool to get companies from a company list. Use when you need a paginated list of companies after specifying a list ID.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of companies to return.
>
> **listId** `integer` *required*
>
> The ID of the company list to retrieve companies from.
>
> **offset** `integer`
>
> Number of companies to skip for pagination.
>
> **keyword** `string`
>
> Keyword to filter companies by name or description.
>
> #### 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 Conversations V2
>
> **Slug:** `HEYREACH_GET_CONVERSATIONS_V2`
>
> Tool to retrieve paginated LinkedIn conversations with advanced filters. Use when you need to fetch inbox conversations filtered by lead or profile details.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of items to return (1-100)
>
> **offset** `integer`
>
> Number of items to skip for pagination
>
> **filters** `object` *required*
>
> Filtering criteria for the conversations
>
> #### 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 Lead
>
> **Slug:** `HEYREACH_GET_LEAD`
>
> Tool to retrieve detailed information for a lead by profile URL. Use after obtaining the exact LinkedIn profile URL to fetch full lead details.
>
> #### Input Parameters
>
> **profileUrl** `string` *required*
>
> The LinkedIn profile URL of the lead.
>
> #### 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 Lists For Lead
>
> **Slug:** `HEYREACH_GET_LISTS_FOR_LEAD`
>
> Retrieve a paginated collection of lists containing a lead identified by LinkedIn profile URL. A 404 reporting that no lead matches the search is returned as an empty collection.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of lists to return.
>
> **offset** `integer`
>
> Number of lists to skip for pagination.
>
> **profileUrl** `string` *required*
>
> The LinkedIn profile URL of the lead to find lists for.
>
> #### 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 My Network for Sender
>
> **Slug:** `HEYREACH_GET_MY_NETWORK_FOR_SENDER`
>
> Retrieve a page of LinkedIn network connections for a specified sender account. Supply a zero-based page number and a positive page size to browse the sender's network.
>
> #### Input Parameters
>
> **pageSize** `integer` *required*
>
> Number of items per page (must be positive)
>
> **senderId** `integer` *required*
>
> ID of the LinkedIn sender account for which to retrieve the network
>
> **pageNumber** `integer` *required*
>
> Zero-based index of the page to retrieve
>
> #### 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 Overall Stats
>
> **Slug:** `HEYREACH_GET_OVERALL_STATS`
>
> Retrieve overall performance statistics for LinkedIn accounts and campaigns, including connection requests, messages, replies, and engagement rates. Filter by account IDs, campaign IDs, and date range; empty account or campaign ID lists select all accounts or campaigns, respectively.
>
> #### Input Parameters
>
> **dateTo** `string`
>
> End date for statistics in ISO 8601 format (YYYY-MM-DD)
>
> **dateFrom** `string`
>
> Start date for statistics in ISO 8601 format (YYYY-MM-DD)
>
> **accountIds** `array`
>
> Filter by specific LinkedIn account IDs (empty array returns stats for all accounts)
>
> **campaignIds** `array`
>
> Filter by specific campaign IDs (empty array returns stats for all campaigns)
>
> #### 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 Webhook By ID
>
> **Slug:** `HEYREACH_GET_WEBHOOK_BY_ID`
>
> Tool to retrieve a webhook by its ID. Use when you need detailed configuration of a specific webhook after listing or creating it.
>
> #### Input Parameters
>
> **webhookId** `integer` *required*
>
> The unique identifier of the webhook to retrieve (positive integer)
>
> #### 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 Blacklisted Companies
>
> **Slug:** `HEYREACH_LIST_BLACKLISTED_COMPANIES`
>
> List workspace-blacklisted companies with pagination and resolution filters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of blacklist entries to return (1-100).
>
> **offset** `integer`
>
> Number of blacklist entries to skip for pagination.
>
> **search** `string`
>
> Case-insensitive search across company name and company URL.
>
> **matchingStatus** `string ("Matching" | "Matched" | "NotFound" | "BroadMatch")`
>
> Filter by company resolution status.
>
> #### 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 Blacklisted Leads
>
> **Slug:** `HEYREACH_LIST_BLACKLISTED_LEADS`
>
> List workspace-blacklisted leads and their resolution diagnostics.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of blacklist entries to return, from 1 to 100.
>
> **offset** `integer`
>
> Number of blacklist entries to skip for pagination.
>
> **search** `string`
>
> Case-insensitive identity search across lead names, emails, profile URLs, and LinkedIn member IDs.
>
> **matchingStatus** `string ("Matching" | "Matched" | "NotFound" | "BroadMatch")`
>
> Resolution status to filter by.
>
> #### 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] Update Webhook
>
> **Slug:** `HEYREACH_UPDATE_WEBHOOK`
>
> Tool to update an existing webhook’s configuration. Use when you need to modify a webhook's name, URL, event type, campaigns, or activation status after confirming the webhookId.
>
> #### Input Parameters
>
> **isActive** `boolean`
>
> Activation status of the webhook. True to enable, False to disable, if omitted or null, the existing status is retained.
>
> **eventType** `string ("CONNECTION_REQUEST_SENT" | "CONNECTION_REQUEST_ACCEPTED" | "MESSAGE_SENT" | "MESSAGE_REPLY_RECEIVED" | "INMAIL_SENT" | "INMAIL_REPLY_RECEIVED" | "FOLLOW_SENT" | "LIKED_POST" | "VIEWED_PROFILE" | "CAMPAIGN_COMPLETED" | "LEAD_TAG_UPDATED")`
>
> New event type to trigger the webhook. If omitted or null, the existing eventType is retained.
>
> **webhookId** `string` *required*
>
> Unique identifier of the existing webhook to update.
>
> **webhookUrl** `string`
>
> New destination URL where HeyReach will send POST event payloads. If omitted or null, the existing URL is retained.
>
> **campaignIds** `array`
>
> List of campaign IDs to scope the webhook. If omitted or null, retains existing campaigns; if empty list, listens for the eventType across all campaigns.
>
> **webhookName** `string`
>
> New name for the webhook. If omitted or null, the existing name is retained.
>
> #### 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
