Skip to content
Changelog

Report a bug

Heyreach integration: operations for AI agents

Heyreach connects to Type.com as an integration. This page lists the 88 operations documented for Claude and Codex in Type.com: 15 read, 68 write, 5 destructive.

About Heyreach

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

Categories: Marketing & Social

How to connect Heyreach to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

88 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

88 operations listed.

Authentication

  • Read

    CheckApiKey

    Check If your API key is working.

Campaigns

  • Read

    GetById

    Get a Campaign by id

  • Read

    GetCampaignSequence

    Retrieves the current sequence (workflow) of a campaign as a PublicSequenceNodeDto. The returned object is directly compatible with the sequence field in Create and UpdateSequence - you can use it as-is without modification.

  • Write

    GetAll

    Get a paginated collection of all campaigns. Get up to 100 campaigns per request.

  • Write

    Resume

    Resumes the specified campaign.

  • Write

    Pause

    Pauses the specified campaign.

  • Write

    AddLeadsToCampaign

    Add leads to a campaign. Add up to 100 leads per request. If a LinkedIn account Idis specified in the AccountLeadPairs, that lead will be mapped to the accountin the campaign.

  • Write

    AddLeadsToCampaignV2

    Add leads to a campaign. Add up to 100 leads per request. If a LinkedIn account Idis specified in the AccountLeadPairs, that lead will be mapped to the accountin the campaign.

  • Write

    StopLeadInCampaign

    Stops a lead in a campaign Call this method if you want to stop the progression of a lead in a campaign. Body Parameters campaignId (integer) : The ID of the campaign. leadMemberId: The lead member Id.

  • Write

    GetLeadsFromCampaign

    Gets the leads that are in a campaign. This request corresponds to the "Lead Analytics" screen in the UI. Remark: It shows only the "Pending" leads that are about to start executing actions in the campaign.

  • Write

    GetCampaignsForLead

    Gets Campaigns for a Lead Retrieves the list of campaigns where the specified lead is. Remark: The response will contain campaigns that match the provided lead information, such as email, LinkedIn ID, or profile URL.

  • Write

    StartCampaign

    Activates a campaign that was created via Create . Call this after Create (and after any UpdateSequence / UpdateSchedule / UpdateAccounts configuration) to start running the campaign. The campaign must have a valid sequence and at least one connected LinkedIn sender account.

  • Write

    UpdateSettings

    Updates the general settings of a campaign: name, lead list, and exclusion options. Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. INPROGRESS, FINISHED). If the campaign was SCHEDULED, it reverts to DRAFT.

  • Write

    UpdateSchedule

    Replaces the schedule of a campaign. Defines when the campaign runs each day, which days it is active, the timezone, and optional start/end dates. Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. INPROGRESS, FINISHED).

  • Write

    UpdateAccounts

    Replaces the entire list of LinkedIn sender accounts assigned to a campaign. This is a full replacement , not a merge. Any account not in the new list will be removed. On a PAUSED campaign, leads assigned to a removed account will be stopped and cannot be resumed.

  • Write

    Create

    Creates a campaign in DRAFT status. After the campaign is fully configured, call StartCampaign ( POST /api/public/campaign/StartCampaign?campaignId= ) to activate it. Important: a campaign cannot be activated without a sequence.

  • Write

    UpdateSequence

    Creates or fully replaces the sequence (workflow) of a campaign. The START node is implicit; the root of the request must be your first action node. Every path through the tree must terminate with an END node. Allowed statuses: DRAFT, SCHEDULED, PAUSED.

  • Write

    CreateCampaignFromTemplate

    Creates a new campaign by cloning the sequence and schedule of an existing campaign (the template). The new campaign is created in DRAFT status.

  • Write

    UpdateLeadCustomFields

    Update (upsert) custom fields on a lead in a campaign. Keys are field names, values are field values. If a field exists: its value is updated. If a field does not exist: it is created. If the value is null or an empty string: the field is deleted.

  • Write

    AddLinkedInAccountsToCampaign

    Add LinkedIn accounts as senders to an existing campaign. Previously added senders remain unchanged. Up to 100 LinkedIn accounts can be processed per request. Individual account failures do not fail the whole request; each account returns its own result.

  • Write

    RemoveLinkedInAccountsFromCampaign

    Remove LinkedIn accounts from a campaign. Up to 100 LinkedIn accounts can be processed per request. Individual account failures do not fail the whole request; each account returns its own status , one of: Success , NotPartOfThisCampaign , NotFound .

Inbox

  • Read

    GetChatroom

    Get a LinkedIn conversation with its messages by Id.

  • Write

    GetConversationsV2

    Get a paginated collection of LinkedIn conversations. Get up to 100 lists per request.

  • Write

    GetConversationsV3

    Get a cursor-paginated collection of LinkedIn conversations. Up to 100 items per request. Successor to GetConversationsV2 . Two differences matter: Paging is cursor-based, not offset-based.

  • Write

    SendMessage

    Send a message to a LinkedIn conversation. Parameters: linkedInAccountId - The id of your LinkedIn sender

  • Write

    SetSeenStatus

    Mark a given conversation as seen or unseen based on the seen parameter.

Linked In Accounts

  • Read

    GetById

    Get a LinkedIn account by id

  • Read

    GetAccountStatus

    Get the current connection status of a LinkedIn account. Cached for 10 seconds. Poll after Connect, ConnectWithCookies, Reconnect, or Resync.

  • Read

    GetProxyCountries

    Get all supported proxy country codes usable when connecting an account.

  • Read

    GetAccountProxy

    Get the proxy assigned to a LinkedIn account. Returns only the country code for platform-managed proxies, or full connection details for custom proxies.

  • Write

    GetAll

    Get a paginated collection of all LinkedIn accounts. Get up to 100 accounts per request.

  • Write

    Connect

    Connect a LinkedIn account using username and password. Returns immediately; poll GetAccountStatus to track progress. Provide either proxyCountryCode or customProxy, not both. Requires the Account Login API feature.

  • Write

    ConnectWithCookies

    Connect a LinkedIn account using session cookies. Member id is auto-extracted by authenticating with the cookies. Optionally supply userAgent matching the browser that generated the cookies. Requires the Account Login API feature.

  • Write

    SubmitPin

    Submit a PIN for an account awaiting PIN verification. 409 if the account is not awaiting a PIN.

  • Write

    Reconnect

    Reconnect an existing LinkedIn account using its stored credentials. Returns immediately; poll GetAccountStatus.

  • Write

    ReloginSalesNavigator

    Re-authenticate the Sales Navigator session. Account must be connected and have an active Sales Navigator subscription.

  • Write

    ReloginRecruiter

    Re-authenticate the Recruiter session. Account must be connected and have an active LinkedIn Recruiter subscription.

  • Write

    Resync

    Resync the profile of a LinkedIn account. Returns immediately; poll GetAccountStatus.

  • Write

    UpdateProxy

    Update the proxy assigned to a LinkedIn account. Provide either proxyCountryCode (platform-managed) or customProxy (your own). Providing both or neither returns 400.

  • Write

    UpdateInboxConfiguration

    Update the inbox scrape configuration. Controls how far back inbox messages are synced when the account connects. inboxScrapeMode: 0 = AllTime, 1 = HeyReachOnly.

  • Destructive

    RemoveAccount

    Remove a LinkedIn account. With force=true the account is first removed from all active campaigns before deletion.

Lists

  • Read

    GetById

    Get a lead or company list by Id

  • Write

    GetAll

    Get a paginated collection of all company and lead lists. Get up to 100 lists per request.

  • Write

    GetLeadsFromList

    Get a paginated collection of leads from a lead list. Get up to 1000 leads per request. listId: The id of the lead list. keyword (optional) : A search term to filter leads by name or other relevant fields.

  • Write

    GetCompaniesFromList

    Get a paginated collection of companies from a company list. Get up to 1000 companies per request.

  • Write

    AddLeadsToList

    Add leads to a lead list. Add up to 100 leads per request. The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores . An error will be return in the case the name field does not follow this format.

  • Write

    AddLeadsToListV2

    Add leads to a lead list. Add up to 100 leads per request. Same as the AddLeadsToList request, however this request returns counts for how many of the leads were added, how many were update and how many failed to be added.

  • Write

    GetListsForLead

    Gets Lists for a Lead This endpoint retrieves the lists associated with a specific lead. Remark: The response will include lead lists that match the provided lead details such as email, LinkedIn ID, or profile URL.

  • Write

    CreateEmptyList

    Create an empty lead or company list. You pass the list name and the list type ( USERLIST or COMPANYLIST ). If the type value is left empty, a Lead list will be created by default.

  • Write

    UpdateLeadCustomFields

    Update (upsert) custom fields on a lead in a list. Keys are field names, values are field values. If a field exists: its value is updated. If a field does not exist: it is created. If the value is null or an empty string: the field is deleted. Up to 100 custom fields per request.

  • Destructive

    DeleteLeadsFromList

    Deletes the specified leads from a lead list. Params: listId (integer) : The ID of the list. leadMemberIds : Array of the LinkedIn IDs of the leads to be deleted. In our API responses, this MemberId can also be named as ' linkedinid '.

  • Destructive

    DeleteLeadsFromListByProfileUrl

    Deletes the specified leads from a lead list by LinkedIn profile url. Params: listId (integer) : The ID of the list. profileUrls : Array of LinkedIn urls of the leads to be deleted. NOTE: this endpoint will return OK(200) even if the leads are not found in the list.

Analytics

  • Read

    Get Overall Stats

    Gets the overall stats for the specified filters. Method: POST Content-Type: application/json Request Body accountIds : Array of Ids of the LinkedIn senders. If empty - all the senders will be included. campaignIds: Array of the Ids of the campaigns to be included.

  • Write

    GetOverallStatsByCampaign

    Gets the overall stats broken down per campaign for the specified filters.

Leads

  • Write

    GetLead

    Gets Lead Details This endpoint retrieves the details of a specific lead based on their LinkedIn profile URL. Remark: The response will provide detailed information about the lead that matches the specified profile URL.

  • Write

    AddTags

    Add Tags to Lead Adds tags to the lead. Existing tags will not be changed. leadProfileUrl (optional) : the linkedIn profile url of the lead, for example ' https://www.linkedin.com/in/john-doe/' l eadLinkedInId (string, optional) : The LinkedIn ID of the lead.

  • Write

    GetTags

    Get Tags for a Lead Gets the tags for a lead. The tags are alphabetically sorted. profileUrl : the linkedIn profile url of the lead, for example ' https://www.linkedin.com/in/john-doe/'

  • Write

    ReplaceTags

    Replaces Tags to Lead Removes the existing tags and replaces with the new tags. leadProfileUrl (optional) : the linkedIn profile url of the lead, for example ' https://www.linkedin.com/in/john-doe/' l eadLinkedInId (string, optional) : The LinkedIn ID of the lead.

Lead Tags

  • Write

    CreateTags

    Create one or multiple tags for your workspace. You can assign these tags to leads. Available colors: Blue, Green, Purple, Pink, Red, Cyan, Yellow, Orange.

Webhooks

  • Read

    Get Webhook By Id

    Get Webhook By Id Description Get a webhook by Id.

  • Write

    Create Webhook

    Create Webhook Endpoint POST //api/public/webhooks/CreateWebhook Description This API creates a new webhook that listens to specified events, optionally filtered by campaign IDs.

  • Write

    GetAllWebhooks

    Get All Webhooks Description Get all webhooks.

  • Write

    Update Webhook

    Update Webhook Endpoint PATCH //api/public/webhooks/UpdateWebhook?webhookId=1234 Description This API updates an existing webhook by modifying its configuration, such as name, URL, event type, associated campaigns, and status.

  • Destructive

    Delete Webhook

    Delete Webhook Endpoint Delete //api/public/webhooks/DeleteWebhook?webhookId=1234 Description This API deletes an existing webhook. Query Parameters webhookId ( string ): The unique identifier of the webhook to delete. This must be provided as a query parameter.

My Network

  • Write

    GetMyNetworkForSender

    GetMyNetworkForSender Endpoint POST / api/public/MyNetwork/GetMyNetworkForSender Description Gets paginated list of the network for the specified sender Request Body Example { "pageNumber": 0, "pageSize": 100, "senderId": 1234 } StartFragment Request Parameters senderId (number)…

  • Write

    IsConnection

    IsConnection Endpoint POST / api/public/MyNetwork/IsConnection Description Gets a value indicating if the lead is a connection to the sender Request Body Example { "senderAccountId": 0, "leadProfileUrl": "string", "leadLinkedInId": "string" } StartFragment Request Parameters sen…

Organization

  • Read

    GetWorkspaceApiKeys

    Get Public API, Make, Zapier, N8N and other relevant integration keys for a given workspace.

  • Read

    GetAllWorkspaces

    List all workspaces in your organization.

  • Read

    GetUserById

    Get information about a given user.

  • Write

    CreateWorkspaceApiKeys

    Generate new API/Integration (Make, Zapier, N8N etc...) keys in a given workspace. Available API key types: PUBLIC, N8N, MAKE, ZAPIER, MCP

  • Write

    CreateWorkspace

    Create new workspace in your organization

  • Write

    UpdateWorkspace

    Update a given workspace in your organization.

  • Write

    GetAllUsers

    Get all existing and invited users in your organization. Filter by role and invitation status.

  • Write

    InviteAdmins

    Invite one or multiple users as admins in your organization. The invitation emails will not be sent, only an invitation URL is generated. You can send this URL to the relevant user in order to register them to HeyReach.

  • Write

    InviteMembers

    Invite one or multiple users in your organization. Specify the relevant permissions for each invited user. The invitation emails will not be sent, only an invitation URL is generated. You can send this URL to the relevant user in order to register them to HeyReach.

  • Write

    InviteManagers

    Invite one or multiple users as managers in your organization. Manager users are special kind of users that exist outside your organization and are invited to specific workspaces. These users will not be part of you organization and only have access to the specified workspaces.

  • Write

    GetWorkspaceUsers

    Get all users in a given workspace along with their role and permissions.

  • Write

    GetLinkedInAccounts

    Retrieve LinkedIn accounts across your organization. Supports pagination, optional keyword search and filtering by workspaceIds (empty/omitted returns all workspaces). Requires the Master (Organization) API Key.

  • Write

    MoveToWorkspace

    Move a LinkedIn account from its current workspace to another workspace. Requires the Master (Organization) API Key.

  • Destructive

    DeleteLinkedInAccount

    Delete a LinkedIn account by its ID. This soft-deletes the LinkedIn account. forceDelete=false (default): deletion fails with 400 if the account belongs to an active campaign. forceDelete=true : the account is removed from active campaigns and then deleted.

Enrichment

  • Read

    CheckEnrichEmailJob

    Polls the status of an email-enrichment job created via enrich-email . Path Parameters jobId (long, required) : Id returned by enrich-email when the job was created.

  • Write

    EnrichEmail

    Creates an email-enrichment job for a single lead. Enrichment runs asynchronously - poll enrich-email/check-job/{jobId} with the returned jobId until the job reaches a terminal status. Provide exactly one of profileUrl or leadMemberId .

Blacklist

  • Write

    GetLeads

    Get a paginated collection of the blacklisted leads in your workspace, newest first. The blacklist is workspace-scoped - each workspace keeps its own, and an API key only ever sees its own workspace's entries. offset (optional) : the number of entries to skip. Defaults to 0 .

  • Write

    AddLeads

    Add up to 100 leads to your workspace's blacklist in one call. A blacklisted lead is excluded from your campaigns.

  • Write

    RemoveLeads

    Remove up to 100 leads from your workspace's blacklist. ids (required) : the entry ids to remove - the entries[].id values returned by 'AddLeads', or the id of an item from 'GetLeads'. At least one id is required, and at most 100 per call.

  • Write

    GetCompanies

    Get a paginated collection of the blacklisted companies in your workspace, newest first. The blacklist is workspace-scoped - each workspace keeps its own, and an API key only ever sees its own workspace's entries. offset (optional) : the number of entries to skip. Defaults to 0 .

  • Write

    AddCompanies

    Add up to 100 companies to your workspace's blacklist in one call. Leads working at a blacklisted company are excluded from your campaigns.

  • Write

    RemoveCompanies

    Remove up to 100 companies from your workspace's blacklist. ids (required) : the entry ids to remove - the entries[].id values returned by 'AddCompanies', or the id of an item from 'GetCompanies'. At least one id is required, and at most 100 per call.

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. Heyreach API docs.