# ReachHunt

> Guides, help articles and API reference for ReachHunt, DM outreach for X and LinkedIn. Connect your accounts, build lead lists, run DM campaigns and answer every reply from one inbox.

- [Welcome to ReachHunt](https://docs.reachhunt.ai/index.md): One place for your DM outreach on X and LinkedIn
- [Set up ReachHunt](https://docs.reachhunt.ai/get-started/set-up.md): Create your account and connect your X and LinkedIn accounts in a few minutes
- [Your first campaign](https://docs.reachhunt.ai/get-started/first-campaign.md): Send your first DM campaign in a few minutes
- [Plans and credits](https://docs.reachhunt.ai/get-started/plans.md): What each plan includes and how credits work
- [ReachHunt Help Center](https://docs.reachhunt.ai/help-center/overview.md): Guides and answers for your accounts, inbox, leads, campaigns and team
- [FAQ](https://docs.reachhunt.ai/help-center/faq.md): Quick answers about ReachHunt
- [Connect your accounts](https://docs.reachhunt.ai/help-center/getting-set-up/connect-accounts.md): Connect X and LinkedIn accounts, reconnect them, and connect someone else's account with an invite link
- [Invite your team](https://docs.reachhunt.ai/help-center/getting-set-up/invite-your-team.md): Invite teammates and choose which pages each one can use
- [Workspaces](https://docs.reachhunt.ai/help-center/getting-set-up/workspaces.md): Create, switch, rename and delete workspaces
- [Personalize ReachHunt](https://docs.reachhunt.ai/help-center/getting-set-up/personalize.md): Set up statuses, tags, notifications, translation and inbox settings
- [Using the inbox](https://docs.reachhunt.ai/help-center/inbox/using-the-inbox.md): Read and answer the DMs of every connected account in one place
- [Message requests](https://docs.reachhunt.ai/help-center/inbox/message-requests.md): Answer DMs and invitations from people you haven't talked to yet
- [Organize conversations](https://docs.reachhunt.ai/help-center/inbox/organize-conversations.md): Use tags, statuses, deal values, assignees and notes to keep track of every lead
- [Pipeline](https://docs.reachhunt.ai/help-center/inbox/pipeline.md): Track every lead through your stages on one board
- [Templates](https://docs.reachhunt.ai/help-center/inbox/templates.md): Save messages once and reuse them in campaigns
- [Lead lists](https://docs.reachhunt.ai/help-center/leads/lead-lists.md): Collect the people you want to message into lists
- [Import leads from X](https://docs.reachhunt.ai/help-center/leads/import-from-x.md): Fill an X lead list from followers, posts, lists and chats
- [Import leads from LinkedIn](https://docs.reachhunt.ai/help-center/leads/import-from-linkedin.md): Fill a LinkedIn lead list from searches, your network, posts and groups
- [Other ways to add leads](https://docs.reachhunt.ai/help-center/leads/other-ways-to-add-leads.md): Add leads by hand, from a file, from another list or campaign, or from Smartlead
- [Build a campaign](https://docs.reachhunt.ai/help-center/campaigns/build-a-campaign.md): Choose your audience, write the sequence, set the schedule and pick accounts
- [Track results](https://docs.reachhunt.ai/help-center/campaigns/track-results.md): See what a campaign sent, who replied and what's left
- [Pause, edit and stop a campaign](https://docs.reachhunt.ai/help-center/campaigns/pause-edit-stop.md): Change a running campaign, or pause, stop or delete it
- [Campaign troubleshooting](https://docs.reachhunt.ai/help-center/campaigns/troubleshooting.md): Fix a campaign that won't start, isn't sending, or has failed messages
- [Overview](https://docs.reachhunt.ai/developer-api/introduction.md): The API for your ReachHunt workspace
- [Quick start](https://docs.reachhunt.ai/developer-api/quickstart.md): Send your first DM through the API in five minutes
- [Authentication](https://docs.reachhunt.ai/developer-api/authentication.md): Create an API key and use it to call the API
- [Core concepts](https://docs.reachhunt.ai/developer-api/core-concepts.md): How your workspace, accounts, conversations, leads and campaigns fit together
- [Webhooks overview](https://docs.reachhunt.ai/webhooks/overview.md): Get notified when something changes in your workspace
- [Receiving webhooks](https://docs.reachhunt.ai/webhooks/receiving.md): Answer deliveries, check they came from ReachHunt, and handle retries
- [Response format](https://docs.reachhunt.ai/developer-api/response-format.md): The envelope, conventions and pagination used by every endpoint
- [Errors](https://docs.reachhunt.ai/developer-api/errors.md): Status codes, error messages and what to do about them
- [Rate limits](https://docs.reachhunt.ai/developer-api/rate-limits.md): The sending limits that keep your X and LinkedIn accounts safe
- [Message received](https://docs.reachhunt.ai/webhooks/events/message-received.md): A lead sent a DM to one of your connected accounts.
- [Message sent](https://docs.reachhunt.ai/webhooks/events/message-sent.md): A DM was sent from a connected account: by a campaign, an AI agent, a member, or on the platform itself.
- [Message seen](https://docs.reachhunt.ai/webhooks/events/message-seen.md): A lead read a DM sent from a connected account. Sent once, for the newest DM they had not read yet.
- [Message edited](https://docs.reachhunt.ai/webhooks/events/message-edited.md): A DM was edited, from ReachHunt or on the platform.
- [Message deleted](https://docs.reachhunt.ai/webhooks/events/message-deleted.md): A DM was deleted, from ReachHunt or on the platform.
- [Message reaction added](https://docs.reachhunt.ai/webhooks/events/message-reaction-added.md): Someone reacted to a DM.
- [Message reaction removed](https://docs.reachhunt.ai/webhooks/events/message-reaction-removed.md): A reaction was taken off a DM.
- [Conversation created](https://docs.reachhunt.ai/webhooks/events/conversation-created.md): A new conversation showed up in the inbox.
- [Conversation deleted](https://docs.reachhunt.ai/webhooks/events/conversation-deleted.md): A conversation was deleted, from ReachHunt or on the platform.
- [Conversation archived](https://docs.reachhunt.ai/webhooks/events/conversation-archived.md): A conversation was archived, by a member or by auto-archive.
- [Conversation unarchived](https://docs.reachhunt.ai/webhooks/events/conversation-unarchived.md): An archived conversation came back to the inbox, by a member or because a new message arrived.
- [Lead added to list](https://docs.reachhunt.ai/webhooks/events/lead-added-to-list.md): A lead was added to a lead list, by an import or a copy.
- [Lead status changed](https://docs.reachhunt.ai/webhooks/events/lead-status-changed.md): A lead's pipeline status was set, changed or cleared.
- [Lead tag added](https://docs.reachhunt.ai/webhooks/events/lead-tag-added.md): A tag was added to a lead.
- [Lead tag removed](https://docs.reachhunt.ai/webhooks/events/lead-tag-removed.md): A tag was removed from a lead.
- [Lead note changed](https://docs.reachhunt.ai/webhooks/events/lead-note-changed.md): A lead's note was written, edited or cleared.
- [Lead valuation changed](https://docs.reachhunt.ai/webhooks/events/lead-valuation-changed.md): A lead's deal value was set, changed or cleared.
- [Lead assignee changed](https://docs.reachhunt.ai/webhooks/events/lead-assignee-changed.md): A lead was assigned to a member, reassigned or unassigned.
- [Campaign created](https://docs.reachhunt.ai/webhooks/events/campaign-created.md): A campaign was created.
- [Campaign started](https://docs.reachhunt.ai/webhooks/events/campaign-started.md): A campaign started sending for the first time.
- [Campaign paused](https://docs.reachhunt.ai/webhooks/events/campaign-paused.md): A campaign was paused, by a member or because it could not keep sending.
- [Campaign resumed](https://docs.reachhunt.ai/webhooks/events/campaign-resumed.md): A paused campaign started sending again.
- [Campaign completed](https://docs.reachhunt.ai/webhooks/events/campaign-completed.md): A campaign reached every lead and finished.
- [Campaign stopped](https://docs.reachhunt.ai/webhooks/events/campaign-stopped.md): A campaign was stopped before it finished.
- [Campaign lead contacted](https://docs.reachhunt.ai/webhooks/events/campaign-lead-contacted.md): A campaign sent its first message to a lead, as a DM or an InMail.
- [Campaign follow up sent](https://docs.reachhunt.ai/webhooks/events/campaign-follow-up-sent.md): A campaign sent a follow-up message to a lead, as a DM or an InMail.
- [Campaign lead replied](https://docs.reachhunt.ai/webhooks/events/campaign-lead-replied.md): A lead replied to a campaign for the first time.
- [Campaign lead failed](https://docs.reachhunt.ai/webhooks/events/campaign-lead-failed.md): A campaign could not reach a lead and stopped trying.
- [Connection request sent](https://docs.reachhunt.ai/webhooks/events/connection-request-sent.md): A campaign sent a LinkedIn connection request.
- [Connection request accepted](https://docs.reachhunt.ai/webhooks/events/connection-request-accepted.md): A lead accepted a LinkedIn connection request sent by a campaign.
- [Connection request withdrawn](https://docs.reachhunt.ai/webhooks/events/connection-request-withdrawn.md): A connection request that was never accepted was withdrawn.
- [Account connected](https://docs.reachhunt.ai/webhooks/events/account-connected.md): An X or LinkedIn account was connected or reconnected.
- [Account disconnected](https://docs.reachhunt.ai/webhooks/events/account-disconnected.md): An account needs to be reconnected, or was removed from the workspace.
- [Import completed](https://docs.reachhunt.ai/webhooks/events/import-completed.md): A lead import finished.
- [Import paused](https://docs.reachhunt.ai/webhooks/events/import-paused.md): A lead import was paused, by a member or because it could not go on, for example when credits ran out or the account needs reconnecting.
- [Import failed](https://docs.reachhunt.ai/webhooks/events/import-failed.md): A lead import failed.
- [Tag created](https://docs.reachhunt.ai/webhooks/events/tag-created.md): A tag was created.
- [Tag updated](https://docs.reachhunt.ai/webhooks/events/tag-updated.md): A tag was renamed or recoloured.
- [Tag deleted](https://docs.reachhunt.ai/webhooks/events/tag-deleted.md): A tag was deleted and removed from every lead.
- [Status created](https://docs.reachhunt.ai/webhooks/events/status-created.md): A pipeline status was created.
- [Status updated](https://docs.reachhunt.ai/webhooks/events/status-updated.md): A pipeline status was renamed or recoloured.
- [Status deleted](https://docs.reachhunt.ai/webhooks/events/status-deleted.md): A pipeline status was deleted and cleared from every lead.
- [List workspaces](https://docs.reachhunt.ai/api-reference/workspaces/list-workspaces.md): Returns the workspaces you can reach, with counts. `activeId` is the workspace the API key belongs to.
- [Get workspace](https://docs.reachhunt.ai/api-reference/workspaces/get-workspace.md): Returns one workspace with its plan.
- [List members](https://docs.reachhunt.ai/api-reference/workspaces/list-members.md): Returns the people in the workspace, invited ones included. Not paged.
- [List assignees](https://docs.reachhunt.ai/api-reference/workspaces/list-assignees.md): Returns the people a conversation can be assigned to.
- [List accounts](https://docs.reachhunt.ai/api-reference/accounts/list-accounts.md): Returns the X and LinkedIn accounts connected to your workspace, newest first. Not paged.
- [Get account limits](https://docs.reachhunt.ai/api-reference/accounts/get-account-limits.md): Returns the sending limits of one account, what it used, and how far its warm-up is. LinkedIn and X accounts return different fields.
- [Get limits summary](https://docs.reachhunt.ai/api-reference/accounts/get-limits-summary.md): Returns the sending limits and pace of every connected account, and what they can send together.
- [Get activity summary](https://docs.reachhunt.ai/api-reference/analytics/get-activity-summary.md): Returns messages sent, people contacted and replies over a time range, with one point per bucket, and the latest conversations.
- [Get credits](https://docs.reachhunt.ai/api-reference/credits/get-credits.md): Returns the AI credits of the workspace: what the plan gives, what you bought and what is used.
- [List credit usage](https://docs.reachhunt.ai/api-reference/credits/list-credit-usage.md): Returns every use of AI credits, newest first.
- [List campaigns](https://docs.reachhunt.ai/api-reference/campaigns/list-campaigns.md): Returns your campaigns, newest first, with how many are in each status.
- [Get campaigns overview](https://docs.reachhunt.ai/api-reference/campaigns/get-campaigns-overview.md): Returns totals across all campaigns.
- [Create campaign](https://docs.reachhunt.ai/api-reference/campaigns/create-campaign.md): Creates a draft campaign. Start it with Start campaign.
- [Get campaign](https://docs.reachhunt.ai/api-reference/campaigns/get-campaign.md): Returns one campaign.
- [Update campaign](https://docs.reachhunt.ai/api-reference/campaigns/update-campaign.md): Changes a campaign. Send only the fields you change.
- [Delete campaigns](https://docs.reachhunt.ai/api-reference/campaigns/delete-campaigns.md): Deletes campaigns. A running campaign is stopped first.
- [Start campaign](https://docs.reachhunt.ai/api-reference/campaigns/start-campaign.md): Starts a draft campaign. Its targets are worked out now.
- [Pause campaign](https://docs.reachhunt.ai/api-reference/campaigns/pause-campaign.md): Pauses a running campaign.
- [Resume campaign](https://docs.reachhunt.ai/api-reference/campaigns/resume-campaign.md): Resumes a paused campaign.
- [Stop campaign](https://docs.reachhunt.ai/api-reference/campaigns/stop-campaign.md): Stops a campaign for good.
- [List campaign targets](https://docs.reachhunt.ai/api-reference/campaigns/list-campaign-targets.md): Returns the people in a campaign and where each one stands.
- [Remove campaign targets](https://docs.reachhunt.ai/api-reference/campaigns/remove-campaign-targets.md): Removes people from a campaign. People already messaged are cancelled instead.
- [Get campaign activity](https://docs.reachhunt.ai/api-reference/campaigns/get-campaign-activity.md): Returns messages, replies and connection requests over time.
- [List agents](https://docs.reachhunt.ai/api-reference/agents/list-agents.md): Returns your AI agents, with how many are in each status.
- [Delete agents](https://docs.reachhunt.ai/api-reference/agents/delete-agents.md): Deletes AI agents. They stop replying right away.
- [Pause agent](https://docs.reachhunt.ai/api-reference/agents/pause-agent.md): Stops a live agent from replying until you resume it.
- [Resume agent](https://docs.reachhunt.ai/api-reference/agents/resume-agent.md): Lets a paused agent reply again.
- [List tags](https://docs.reachhunt.ai/api-reference/tags/list-tags.md): Returns every tag in your workspace, in the order they were created. Not paged.
- [Create tag](https://docs.reachhunt.ai/api-reference/tags/create-tag.md): Creates a tag. Pass `accountId` and `conversationId` to put it on a conversation too.
- [Update tag](https://docs.reachhunt.ai/api-reference/tags/update-tag.md): Renames or recolors a tag. Send at least one of `label` and `color`.
- [Delete tag](https://docs.reachhunt.ai/api-reference/tags/delete-tag.md): Deletes a tag and takes it off every conversation.
- [List statuses](https://docs.reachhunt.ai/api-reference/statuses/list-statuses.md): Returns every status in your workspace, in the order they were created. Not paged.
- [Create status](https://docs.reachhunt.ai/api-reference/statuses/create-status.md): Creates a status. Pass `accountId` and `conversationId` to put it on a conversation too.
- [Update status](https://docs.reachhunt.ai/api-reference/statuses/update-status.md): Renames or recolors a status. Send at least one of `label` and `color`.
- [Delete status](https://docs.reachhunt.ai/api-reference/statuses/delete-status.md): Deletes a status and takes it off every conversation.
- [Update lead tags](https://docs.reachhunt.ai/api-reference/leads/update-lead-tags.md): Adds and removes tags on several leads.
- [Set lead status](https://docs.reachhunt.ai/api-reference/leads/set-lead-status.md): Puts several leads in one status, or clears it.
- [Get lead note](https://docs.reachhunt.ai/api-reference/leads/get-lead-note.md): Returns the note on a lead.
- [Set lead note](https://docs.reachhunt.ai/api-reference/leads/set-lead-note.md): Replaces the note on a lead. An empty string clears it.
- [Get lead value](https://docs.reachhunt.ai/api-reference/leads/get-lead-value.md): Returns the deal value of a lead.
- [Set lead value](https://docs.reachhunt.ai/api-reference/leads/set-lead-value.md): Sets the deal value of a lead. `null` clears it.
- [List lead lists](https://docs.reachhunt.ai/api-reference/lead-lists/list-lead-lists.md): Returns the lead lists in your workspace, newest first. The read-only system lists come back in `systemLists` on the first page.
- [Create lead list](https://docs.reachhunt.ai/api-reference/lead-lists/create-lead-list.md): Creates an empty lead list. Fill it with Add leads or Start import.
- [Get lead list](https://docs.reachhunt.ai/api-reference/lead-lists/get-lead-list.md): Returns one lead list with its imports.
- [Rename lead list](https://docs.reachhunt.ai/api-reference/lead-lists/rename-lead-list.md): Renames a lead list.
- [Delete lead lists](https://docs.reachhunt.ai/api-reference/lead-lists/delete-lead-lists.md): Deletes lead lists and the people in them.
- [List leads](https://docs.reachhunt.ai/api-reference/lead-lists/list-leads.md): Returns the people in a lead list.
- [Add leads](https://docs.reachhunt.ai/api-reference/lead-lists/add-leads.md): Adds people to a lead list by their network ID.
- [Remove leads](https://docs.reachhunt.ai/api-reference/lead-lists/remove-leads.md): Removes people from a lead list.
- [Start import](https://docs.reachhunt.ai/api-reference/lead-lists/start-import.md): Starts filling a lead list from a source, such as an account's followers, a post's likes or a LinkedIn search. The import runs in the background.
- [List imports](https://docs.reachhunt.ai/api-reference/lead-lists/list-imports.md): Returns the imports of a lead list.
- [Pause import](https://docs.reachhunt.ai/api-reference/lead-lists/pause-import.md): Pauses one import.
- [Resume import](https://docs.reachhunt.ai/api-reference/lead-lists/resume-import.md): Resumes one import.
- [Stop import](https://docs.reachhunt.ai/api-reference/lead-lists/stop-import.md): Stops one import.
- [List conversations](https://docs.reachhunt.ai/api-reference/conversations/list-conversations.md): Returns the one-to-one conversations in your workspace, across every connected account or for one. Open conversations are returned unless you change `scope`. Paged with a cursor.
- [Get conversation](https://docs.reachhunt.ai/api-reference/conversations/get-conversation.md): Returns one conversation.
- [Find or start conversation](https://docs.reachhunt.ai/api-reference/conversations/find-or-start-conversation.md): Returns the conversation between an account and a person. When there is none yet, a draft is created that becomes a real conversation once you send the first message.
- [Mark as read](https://docs.reachhunt.ai/api-reference/conversations/mark-as-read.md): Marks a conversation as read.
- [Mark as unread](https://docs.reachhunt.ai/api-reference/conversations/mark-as-unread.md): Marks a conversation as unread.
- [Close conversation](https://docs.reachhunt.ai/api-reference/conversations/close-conversation.md): Closes a conversation. It leaves the open list.
- [Reopen conversation](https://docs.reachhunt.ai/api-reference/conversations/reopen-conversation.md): Reopens a closed conversation.
- [Delete conversation](https://docs.reachhunt.ai/api-reference/conversations/delete-conversation.md): Deletes a conversation and its messages.
- [List requests](https://docs.reachhunt.ai/api-reference/conversations/list-requests.md): Returns message requests and connection invitations waiting for an answer on one account.
- [Answer request](https://docs.reachhunt.ai/api-reference/conversations/answer-request.md): Accepts, ignores, withdraws or deletes a request. Use one of the request's `actions`.
- [List messages](https://docs.reachhunt.ai/api-reference/messages/list-messages.md): Returns the messages of a conversation, newest first. Paged with a cursor.
- [Send message](https://docs.reachhunt.ai/api-reference/messages/send-message.md): Sends a message in a conversation, or the first message of a draft from Find or start conversation. Send text, a file, or both: use JSON for text, or `multipart/form-data` to attach a file.
- [Edit message](https://docs.reachhunt.ai/api-reference/messages/edit-message.md): Edits a message you sent. LinkedIn allows it for a short time after sending.
- [Delete message](https://docs.reachhunt.ai/api-reference/messages/delete-message.md): Deletes a message, for you or for everyone.
- [Add reaction](https://docs.reachhunt.ai/api-reference/messages/add-reaction.md): Reacts to a message with an emoji.
- [Remove reaction](https://docs.reachhunt.ai/api-reference/messages/remove-reaction.md): Removes your reaction from a message.
- [Add tag](https://docs.reachhunt.ai/api-reference/conversation-details/add-tag.md): Puts a tag on the person in a conversation.
- [Remove tag](https://docs.reachhunt.ai/api-reference/conversation-details/remove-tag.md): Takes a tag off the person in a conversation.
- [Set status](https://docs.reachhunt.ai/api-reference/conversation-details/set-status.md): Puts the person in a conversation in a status, or clears it.
- [Get note](https://docs.reachhunt.ai/api-reference/conversation-details/get-note.md): Returns the note on the person in a conversation.
- [Set note](https://docs.reachhunt.ai/api-reference/conversation-details/set-note.md): Replaces the note. An empty string clears it.
- [Get value](https://docs.reachhunt.ai/api-reference/conversation-details/get-value.md): Returns the deal value of the person in a conversation.
- [Set value](https://docs.reachhunt.ai/api-reference/conversation-details/set-value.md): Sets the deal value. `null` clears it.
- [Get assignee](https://docs.reachhunt.ai/api-reference/conversation-details/get-assignee.md): Returns who the conversation is assigned to.
- [Set assignee](https://docs.reachhunt.ai/api-reference/conversation-details/set-assignee.md): Assigns the conversation to a teammate from List assignees, or clears it.
- [List internal notes](https://docs.reachhunt.ai/api-reference/internal-notes/list-internal-notes.md): Returns the notes your team left on a conversation. The other person never sees them.
- [Add internal note](https://docs.reachhunt.ai/api-reference/internal-notes/add-internal-note.md): Adds a note for your team.
- [Delete internal note](https://docs.reachhunt.ai/api-reference/internal-notes/delete-internal-note.md): Deletes a note.
- [List scheduled messages](https://docs.reachhunt.ai/api-reference/scheduled-messages/list-scheduled-messages.md): Returns the messages set to send later in a conversation.
- [Schedule message](https://docs.reachhunt.ai/api-reference/scheduled-messages/schedule-message.md): Sets a message to send later.
- [Update scheduled message](https://docs.reachhunt.ai/api-reference/scheduled-messages/update-scheduled-message.md): Changes the text or the time.
- [Send now](https://docs.reachhunt.ai/api-reference/scheduled-messages/send-now.md): Sends a scheduled message right away.
- [Cancel scheduled message](https://docs.reachhunt.ai/api-reference/scheduled-messages/cancel-scheduled-message.md): Cancels a scheduled message.
- [List templates](https://docs.reachhunt.ai/api-reference/templates/list-templates.md): Returns your saved messages.
- [Create template](https://docs.reachhunt.ai/api-reference/templates/create-template.md): Saves a message to reuse.
- [Update template](https://docs.reachhunt.ai/api-reference/templates/update-template.md): Changes a template. Send only the fields you change.
- [Duplicate template](https://docs.reachhunt.ai/api-reference/templates/duplicate-template.md): Makes a copy of a template.
- [Delete template](https://docs.reachhunt.ai/api-reference/templates/delete-template.md): Deletes a template.
- [Integrations](https://docs.reachhunt.ai/integrations/overview.md): Connect ReachHunt to your AI apps, automations, CRM and email tools
- [MCP server](https://docs.reachhunt.ai/integrations/mcp-server.md): Use ReachHunt inside Claude, ChatGPT, Cursor and other AI apps
- [n8n](https://docs.reachhunt.ai/integrations/n8n.md): Run ReachHunt actions and start workflows from ReachHunt events
- [HubSpot](https://docs.reachhunt.ai/integrations/hubspot.md): Send leads, conversations and deals to HubSpot
- [Pipedrive](https://docs.reachhunt.ai/integrations/pipedrive.md): Send leads, conversations and deals to Pipedrive
- [Smartlead](https://docs.reachhunt.ai/integrations/smartlead.md): Send leads to Smartlead email campaigns

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.