HeyReach

App · 20 actions

Run your HeyReach LinkedIn outreach: add leads to campaigns and lists, pause or resume campaigns, read and answer inbox conversations, tag leads and get outreach stats.

Actions

ActionWhat it does
Add lead to campaignAdd a lead to a campaign by their LinkedIn profile, so the campaign reaches out to them.
Add lead to listAdd a lead to a lead list by their LinkedIn profile.
Create listCreate an empty lead list (or company list) to add leads to.
Get campaignGet one campaign with its status, lead list, senders and how many leads are in progress, finished or failed.
Get conversationGet one LinkedIn conversation with all its messages.
Get leadGet what HeyReach knows about a lead from their LinkedIn profile: name, job, company, location and any email found.
Get listGet one list with its type, size and the campaigns using it.
Get outreach statsGet invitations sent and accepted, messages, replies, InMails and reply rates, in total and day by day, for all or some senders and campaigns.
List campaign leadsList a campaign's leads with where each is in the sequence, whether they accepted the invitation and whether they replied.
List campaignsList campaigns with their status, lead list, senders and progress, filtered by name, status or sender.
List conversationsList LinkedIn conversations from the HeyReach inbox with their latest messages, filtered by sender, campaign, lead, tag or read state.
List leads in listList the leads in a lead list, optionally only those added in a time range or matching a name.
List LinkedIn sendersList the LinkedIn accounts connected to HeyReach as senders, with whether each is signed in, its active campaigns and its daily limits.
List listsList lead and company lists with their sizes and campaigns.
Pause campaignPause a running campaign, so it stops reaching out.
Remove lead from listRemove a lead from a lead list by their LinkedIn profile.
Resume campaignResume a paused campaign.
Send messageSend a LinkedIn message into a conversation from its sender's LinkedIn account.
Stop lead in campaignStop a campaign reaching out to one lead, such as someone who booked a call.
Tag leadAdd tags to a lead, keeping the tags they already have, such as 'interested' after a reply.

Add lead to campaign

Add a lead to a campaign by their LinkedIn profile, so the campaign reaches out to them. A lead already in it is updated.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
LinkedIn profileprofile_urltextRequired
The lead's LinkedIn profile address.
LinkedIn senderlinkedin_account_idtext
The campaign's sender who should reach this lead. Leave empty to let HeyReach choose.
First namefirst_nametext
The lead's first name.
Last namelast_nametext
The lead's last name.
Emailemailtext
The lead's email address.
Companycompany_nametext
Where the lead works.
Job titlepositiontext
The lead's job title.
Locationlocationtext
Where the lead is based.
Aboutabouttext
A note about the lead, usable in message templates.
Custom fieldscustom_fieldsobject
Your own fields for message templates, such as {"favorite_color": "blue"}. Names use only letters, digits and _.
Resume if pausedresume_paused_campaigntext
Resume the campaign if it is paused. Defaults to no.One of: true (Yes), false (No).
Resume if finishedresume_finished_campaigntext
Start the campaign again if it has finished. Defaults to no.One of: true (Yes), false (No).

Outputs

added_countnumber
1 if the lead is new
campaign_idnumber
The campaign
failed_countnumber
Leads HeyReach could not add
profile_urltext
The lead's profile address
updated_countnumber
1 if it was already there
Example output
{
  "added_count": 1,
  "campaign_id": 274079,
  "failed_count": 0,
  "profile_url": "https://www.linkedin.com/in/jane-doe",
  "updated_count": 0
}

Add lead to list

Add a lead to a lead list by their LinkedIn profile. This does not start a campaign for them; use 'Add lead to campaign' for that.

Inputs

Listlist_idtextRequired
The lead list. Pick one, or give its id from an earlier step.
LinkedIn profileprofile_urltextRequired
The lead's LinkedIn profile address.
First namefirst_nametext
The lead's first name.
Last namelast_nametext
The lead's last name.
Emailemailtext
The lead's email address.
Companycompany_nametext
Where the lead works.
Job titlepositiontext
The lead's job title.
Locationlocationtext
Where the lead is based.
Aboutabouttext
A note about the lead, usable in message templates.
Custom fieldscustom_fieldsobject
Your own fields for message templates, such as {"favorite_color": "blue"}. Names use only letters, digits and _.

Outputs

added_countnumber
1 if the lead is new
failed_countnumber
Leads HeyReach could not add
list_idnumber
The list
profile_urltext
The lead's profile address
updated_countnumber
1 if it was already there
Example output
{
  "added_count": 1,
  "failed_count": 0,
  "list_id": 3457,
  "profile_url": "https://www.linkedin.com/in/jane-doe",
  "updated_count": 0
}

Create list

Create an empty lead list (or company list) to add leads to.

Inputs

NamenametextRequired
The list's name.
Typelist_typetext
A list of people or of companies. Defaults to people.One of: USER_LIST (Lead list), COMPANY_LIST (Company list).

Outputs

listobject
The new list
Example output
{
  "list": {
    "count": 0,
    "creationTime": "2026-10-04T09:34:56Z",
    "id": 3458,
    "listType": "USER_LIST",
    "name": "Event leads",
    "status": "UNKNOWN"
  }
}

Get campaign

Get one campaign with its status, lead list, senders and how many leads are in progress, finished or failed.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "campaignAccountIds": [
      113298
    ],
    "creationTime": "2026-10-01T08:06:15Z",
    "excludeListId": 0,
    "id": 274079,
    "linkedInUserListId": 123456,
    "linkedInUserListName": "Webinar leads",
    "name": "My First Campaign",
    "progressStats": {
      "totalUsers": 9,
      "totalUsersExcluded": 0,
      "totalUsersFailed": 0,
      "totalUsersFinished": 1,
      "totalUsersInProgress": 8,
      "totalUsersManuallyStopped": 0,
      "totalUsersPending": 0
    },
    "status": "IN_PROGRESS"
  }
}

Get conversation

Get one LinkedIn conversation with all its messages.

Inputs

LinkedIn senderlinkedin_account_idtextRequired
The LinkedIn account in HeyReach the conversation belongs to. Pick one, or give its id from 'List conversations'.
Conversation IDconversation_idtextRequired
The conversation's id, from 'List conversations' or a trigger.

Outputs

conversationobject
The conversation
Example output
{
  "conversation": {
    "correspondentProfile": {
      "about": "",
      "companyName": "Acme",
      "companyUrl": "https://www.linkedin.com/company/acme",
      "connections": 500,
      "customFields": [
        {
          "name": "favorite_color",
          "value": "blue"
        }
      ],
      "emailAddress": "jane@example.com",
      "firstName": "Jane",
      "followers": 820,
      "headline": "Head of Marketing at Acme",
      "imageUrl": "https://media.licdn.com/dms/image/jane.jpg",
      "lastName": "Doe",
      "linkedin_id": "58344979",
      "location": "Austin, Texas",
      "position": "Head of Marketing",
      "profileUrl": "https://www.linkedin.com/in/jane-doe",
      "tags": [
        "webinar"
      ]
    },
    "groupChat": false,
    "id": "2-ODM0YmIzNzgtOGEyOS00ZTYz",
    "lastMessageAt": "2026-10-03T12:00:19Z",
    "lastMessageSender": "CORRESPONDENT",
    "lastMessageText": "Thanks, happy to chat next week.",
    "lastMessageType": "TEXT",
    "linkedInAccount": {
      "authIsValid": true,
      "emailAddress": "sam@example.com",
      "firstName": "Sam",
      "id": 113298,
      "lastName": "Seller",
      "profileUrl": "https://www.linkedin.com/in/sam-seller"
    },
    "linkedInAccountId": 113298,
    "messages": [
      {
        "body": "Hi Jane, loved your webinar.",
        "createdAt": "2026-10-02T09:00:00Z",
        "isInMail": false,
        "postLink": "",
        "sender": "ME",
        "subject": ""
      },
      {
        "body": "Thanks, happy to chat next week.",
        "createdAt": "2026-10-03T12:00:19Z",
        "isInMail": false,
        "postLink": "",
        "sender": "CORRESPONDENT",
        "subject": ""
      }
    ],
    "read": false,
    "totalMessages": 2
  }
}

Get lead

Get what HeyReach knows about a lead from their LinkedIn profile: name, job, company, location and any email found.

Inputs

LinkedIn profileprofile_urltextRequired
The lead's LinkedIn profile address.

Outputs

leadobject
The lead
Example output
{
  "lead": {
    "about": "",
    "companyName": "Acme",
    "companyUrl": "https://www.linkedin.com/company/acme",
    "connections": 500,
    "emailAddress": "jane@example.com",
    "enrichedEmailAddress": "jane@acme.example",
    "firstName": "Jane",
    "followers": 820,
    "fullName": "Jane Doe",
    "headline": "Head of Marketing at Acme",
    "imageUrl": "https://media.licdn.com/dms/image/jane.jpg",
    "industry": "Software",
    "lastName": "Doe",
    "linkedin_id": "58344979",
    "location": "Austin, Texas",
    "position": "Head of Marketing",
    "profileUrl": "https://www.linkedin.com/in/jane-doe",
    "summary": "",
    "username": "jane-doe"
  }
}

Get list

Get one list with its type, size and the campaigns using it.

Inputs

Listlist_idtextRequired
The lead list. Pick one, or give its id from an earlier step.

Outputs

listobject
The list
Example output
{
  "list": {
    "campaignIds": [
      274079
    ],
    "creationTime": "2026-09-30T09:34:56Z",
    "id": 3457,
    "listType": "USER_LIST",
    "name": "Webinar leads",
    "totalItemsCount": 120
  }
}

Get outreach stats

Get invitations sent and accepted, messages, replies, InMails and reply rates, in total and day by day, for all or some senders and campaigns.

Inputs

Fromstart_datedate
The first day. Defaults to six days before the last day.
Toend_datedate
The last day, included. Defaults to today (UTC).
LinkedIn senderslinkedin_account_idslist
Only these senders. Leave empty for all of them.
Campaignscampaign_idslist
Only these campaigns. Leave empty for all of them.

Outputs

countnumber
How many days
dayslist
The figures for each day
end_datetext
Last day (YYYY-MM-DD)
overallobject
Totals for the whole range
start_datetext
First day (YYYY-MM-DD)
Example output
{
  "count": 1,
  "days": [
    {
      "connectionAcceptanceRate": 0.26,
      "connectionsAccepted": 31,
      "connectionsSent": 120,
      "date": "2026-10-01",
      "follows": 1,
      "inMailReplyRate": 0.0,
      "inmailMessagesSent": 0,
      "messageReplyRate": 0.3,
      "messagesSent": 40,
      "postLikes": 3,
      "profileViews": 12,
      "totalInmailReplies": 0,
      "totalInmailStarted": 0,
      "totalMessageReplies": 9,
      "totalMessageStarted": 30
    }
  ],
  "end_date": "2026-10-01",
  "overall": {
    "connectionAcceptanceRate": 0.26,
    "connectionsAccepted": 31,
    "connectionsSent": 120,
    "follows": 1,
    "inMailReplyRate": 0.0,
    "inmailMessagesSent": 0,
    "messageReplyRate": 0.3,
    "messagesSent": 40,
    "postLikes": 3,
    "profileViews": 12,
    "totalInmailReplies": 0,
    "totalInmailStarted": 0,
    "totalMessageReplies": 9,
    "totalMessageStarted": 30
  },
  "start_date": "2026-10-01"
}

List campaign leads

List a campaign's leads with where each is in the sequence, whether they accepted the invitation and whether they replied. Gets one page; to see more, run it again with the next offset.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Time range applies totime_filtertext
What the From and To times filter on. Defaults to when the lead was added.One of: CreationTime (Added to the campaign), LastActionTakenTime (Last action taken), FailedTime (Failed), LastActionTakenOrFailedTime (Last action taken or failed).
Fromtime_fromdate and time
Only leads from this time on.
Totime_todate and time
Only leads up to this time.
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

campaign_idnumber
The campaign
countnumber
How many on this page
has_moretrue/false
Whether there is another page
leadslist
The campaign's leads
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "campaign_id": 274079,
  "count": 1,
  "has_more": false,
  "leads": [
    {
      "creationTime": "2026-10-01T21:28:06Z",
      "failedTime": "",
      "id": 62658,
      "lastActionTime": "2026-10-02T03:28:22Z",
      "leadCampaignStatus": "InSequence",
      "leadCampaignStatusMessage": "",
      "leadConnectionStatus": "ConnectionAccepted",
      "leadMessageStatus": "MessageSent",
      "linkedInSenderFullName": "Sam Seller",
      "linkedInSenderId": 113298,
      "linkedInUserProfile": {
        "about": "",
        "companyName": "Acme",
        "companyUrl": "https://www.linkedin.com/company/acme",
        "connections": 500,
        "customFields": [
          {
            "name": "favorite_color",
            "value": "blue"
          }
        ],
        "emailAddress": "jane@example.com",
        "firstName": "Jane",
        "followers": 820,
        "headline": "Head of Marketing at Acme",
        "imageUrl": "https://media.licdn.com/dms/image/jane.jpg",
        "lastName": "Doe",
        "linkedin_id": "58344979",
        "location": "Austin, Texas",
        "position": "Head of Marketing",
        "profileUrl": "https://www.linkedin.com/in/jane-doe",
        "tags": [
          "webinar"
        ]
      },
      "linkedInUserProfileId": "AC9sANasX0Ia"
    }
  ],
  "next_offset": 1,
  "total_count": 1
}

List campaigns

List campaigns with their status, lead list, senders and progress, filtered by name, status or sender. Gets one page; to see more, run it again with the next offset it gives.

Inputs

Name containskeywordtext
Only those whose name contains this text.
Statusesstatuseslist
Only campaigns in these states. Leave empty for all.One or more of: DRAFT, STARTING, SCHEDULED, IN_PROGRESS (In progress), PAUSED, FINISHED, CANCELED, FAILED.
LinkedIn senderslinkedin_account_idslist
Only these senders. Leave empty for all of them.
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

campaignslist
The campaigns
countnumber
How many on this page
has_moretrue/false
Whether there is another page
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "campaigns": [
    {
      "campaignAccountIds": [
        113298
      ],
      "creationTime": "2026-10-01T08:06:15Z",
      "excludeListId": 0,
      "id": 274079,
      "linkedInUserListId": 123456,
      "linkedInUserListName": "Webinar leads",
      "name": "My First Campaign",
      "progressStats": {
        "totalUsers": 9,
        "totalUsersExcluded": 0,
        "totalUsersFailed": 0,
        "totalUsersFinished": 1,
        "totalUsersInProgress": 8,
        "totalUsersManuallyStopped": 0,
        "totalUsersPending": 0
      },
      "status": "IN_PROGRESS"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "total_count": 1
}

List conversations

List LinkedIn conversations from the HeyReach inbox with their latest messages, filtered by sender, campaign, lead, tag or read state. Gets one page; to see more, run it again with the next offset.

Inputs

LinkedIn senderslinkedin_account_idslist
Only these senders. Leave empty for all of them.
Campaignscampaign_idslist
Only these campaigns. Leave empty for all of them.
Searchsearchtext
Only conversations matching this text.
Lead's LinkedIn profilelead_profile_urltext
Only conversations with this lead.
Lead tagstagslist
Only leads with at least one of these tags.
Read stateseentext
Read, unread or both. Defaults to both.One of: any (Read and unread (default)), unseen (Unread only), seen (Read only).
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

conversationslist
The conversations
countnumber
How many on this page
has_moretrue/false
Whether there is another page
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "conversations": [
    {
      "correspondentProfile": {
        "about": "",
        "companyName": "Acme",
        "companyUrl": "https://www.linkedin.com/company/acme",
        "connections": 500,
        "customFields": [
          {
            "name": "favorite_color",
            "value": "blue"
          }
        ],
        "emailAddress": "jane@example.com",
        "firstName": "Jane",
        "followers": 820,
        "headline": "Head of Marketing at Acme",
        "imageUrl": "https://media.licdn.com/dms/image/jane.jpg",
        "lastName": "Doe",
        "linkedin_id": "58344979",
        "location": "Austin, Texas",
        "position": "Head of Marketing",
        "profileUrl": "https://www.linkedin.com/in/jane-doe",
        "tags": [
          "webinar"
        ]
      },
      "groupChat": false,
      "id": "2-ODM0YmIzNzgtOGEyOS00ZTYz",
      "lastMessageAt": "2026-10-03T12:00:19Z",
      "lastMessageSender": "CORRESPONDENT",
      "lastMessageText": "Thanks, happy to chat next week.",
      "lastMessageType": "TEXT",
      "linkedInAccount": {
        "authIsValid": true,
        "emailAddress": "sam@example.com",
        "firstName": "Sam",
        "id": 113298,
        "lastName": "Seller",
        "profileUrl": "https://www.linkedin.com/in/sam-seller"
      },
      "linkedInAccountId": 113298,
      "messages": [
        {
          "body": "Hi Jane, loved your webinar.",
          "createdAt": "2026-10-02T09:00:00Z",
          "isInMail": false,
          "postLink": "",
          "sender": "ME",
          "subject": ""
        },
        {
          "body": "Thanks, happy to chat next week.",
          "createdAt": "2026-10-03T12:00:19Z",
          "isInMail": false,
          "postLink": "",
          "sender": "CORRESPONDENT",
          "subject": ""
        }
      ],
      "read": false,
      "totalMessages": 2
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "total_count": 1
}

List leads in list

List the leads in a lead list, optionally only those added in a time range or matching a name. Gets one page of up to 1,000; to see more, run it again with the next offset.

Inputs

Listlist_idtextRequired
The lead list. Pick one, or give its id from an earlier step.
Name containskeywordtext
Only those whose name contains this text.
Lead's LinkedIn profilelead_profile_urltext
Only this lead.
Added fromcreated_fromdate and time
Only leads added at or after this time.
Added untilcreated_todate and time
Only leads added at or before this time.
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 1000.From 1 to 1000.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether there is another page
leadslist
The list's leads
list_idnumber
The list
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "leads": [
    {
      "about": "",
      "companyName": "Acme",
      "companyUrl": "https://www.linkedin.com/company/acme",
      "connections": 500,
      "customFields": [
        {
          "name": "favorite_color",
          "value": "blue"
        }
      ],
      "emailAddress": "jane@example.com",
      "firstName": "Jane",
      "followers": 820,
      "headline": "Head of Marketing at Acme",
      "imageUrl": "https://media.licdn.com/dms/image/jane.jpg",
      "lastName": "Doe",
      "linkedin_id": "58344979",
      "location": "Austin, Texas",
      "position": "Head of Marketing",
      "profileUrl": "https://www.linkedin.com/in/jane-doe",
      "tags": [
        "webinar"
      ]
    }
  ],
  "list_id": 3457,
  "next_offset": 1,
  "total_count": 1
}

List LinkedIn senders

List the LinkedIn accounts connected to HeyReach as senders, with whether each is signed in, its active campaigns and its daily limits.

Inputs

Name containskeywordtext
Only those whose name contains this text.
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

accountslist
The LinkedIn senders
countnumber
How many on this page
has_moretrue/false
Whether there is another page
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "accounts": [
    {
      "accountLimits": {
        "connectioRequestLimit": 20,
        "connectioRequestMax": 50,
        "inMailLimit": 0,
        "inMailLimitMax": 50,
        "messageLimit": 50,
        "messageLimitMax": 150,
        "profileViewLimit": 80,
        "profileViewLimitMax": 150
      },
      "activeCampaigns": 2,
      "authIsValid": true,
      "emailAddress": "sam@example.com",
      "firstName": "Sam",
      "id": 113298,
      "isActive": true,
      "isValidNavigator": false,
      "isValidRecruiter": false,
      "lastName": "Seller",
      "profileUrl": "https://www.linkedin.com/in/sam-seller"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 1,
  "total_count": 1
}

List lists

List lead and company lists with their sizes and campaigns. Gets one page; to see more, run it again with the next offset.

Inputs

Name containskeywordtext
Only those whose name contains this text.
Typelist_typetext
Only lead lists or only company lists.One of: USER_LIST (Lead list), COMPANY_LIST (Company list).
Skipoffsetnumber
How many to skip, for the next page: give the 'next_offset' an earlier run returned. Defaults to 0.At least 0.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether there is another page
listslist
The lists
next_offsetnumber
The offset to give for the next page
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "has_more": false,
  "lists": [
    {
      "campaignIds": [
        274079
      ],
      "creationTime": "2026-09-30T09:34:56Z",
      "id": 3457,
      "listType": "USER_LIST",
      "name": "Webinar leads",
      "totalItemsCount": 120
    }
  ],
  "next_offset": 1,
  "total_count": 1
}

Pause campaign

Pause a running campaign, so it stops reaching out.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaign_idnumber
The campaign paused
pausedtrue/false
Always true once paused
Example output
{
  "campaign_id": 274079,
  "paused": true
}

Remove lead from list

Remove a lead from a lead list by their LinkedIn profile.

Inputs

Listlist_idtextRequired
The lead list. Pick one, or give its id from an earlier step.
LinkedIn profileprofile_urltextRequired
The lead's LinkedIn profile address.

Outputs

list_idnumber
The list
not_foundlist
Profile names HeyReach did not find in the list
profile_urltext
The lead's profile
removedtrue/false
False if the lead was not in the list
Example output
{
  "list_id": 3457,
  "not_found": [],
  "profile_url": "https://www.linkedin.com/in/jane-doe",
  "removed": true
}

Resume campaign

Resume a paused campaign. It starts sending LinkedIn invitations and messages to its leads again.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaign_idnumber
The campaign resumed
resumedtrue/false
Always true once resumed
Example output
{
  "campaign_id": 274079,
  "resumed": true
}

Send message

Send a LinkedIn message into a conversation from its sender's LinkedIn account. The lead receives it at once.

Inputs

LinkedIn senderlinkedin_account_idtextRequired
The LinkedIn account in HeyReach the conversation belongs to. Pick one, or give its id from 'List conversations'.
Conversation IDconversation_idtextRequired
The conversation's id, from 'List conversations' or a trigger.
MessagemessagetextRequired
The text to send.
Subjectsubjecttext
A subject, used only for InMail conversations.

Outputs

conversation_idtext
The conversation
linkedin_account_idnumber
The sender
senttrue/false
Always true once sent
Example output
{
  "conversation_id": "2-ODM0YmIzNzgtOGEyOS00ZTYz",
  "linkedin_account_id": 113298,
  "sent": true
}

Stop lead in campaign

Stop a campaign reaching out to one lead, such as someone who booked a call. Give their LinkedIn profile or LinkedIn id.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
LinkedIn profileprofile_urltext
The lead's LinkedIn profile address.
Lead's LinkedIn idlead_linkedin_idtext
Instead of the profile: the lead's linkedin_id from 'List campaign leads' or 'Get lead'.

Outputs

campaign_idnumber
The campaign
lead_linkedin_idtext
The lead's id
profile_urltext
The lead's profile
stoppedtrue/false
Always true once stopped
Example output
{
  "campaign_id": 274079,
  "lead_linkedin_id": "",
  "profile_url": "https://www.linkedin.com/in/jane-doe",
  "stopped": true
}

Tag lead

Add tags to a lead, keeping the tags they already have, such as 'interested' after a reply.

Inputs

LinkedIn profileprofile_urltextRequired
The lead's LinkedIn profile address.
TagstagslistRequired
The tags to add.
Create new tagscreate_missing_tagstext
Create any tag HeyReach doesn't have yet. If no, a new tag makes the step fail. Defaults to yes.One of: true (Yes), false (No).

Outputs

new_tagslist
Tags the lead did not have before
profile_urltext
The lead's profile
tagslist
Tags given
Example output
{
  "new_tags": [
    "interested"
  ],
  "profile_url": "https://www.linkedin.com/in/jane-doe",
  "tags": [
    "interested"
  ]
}

On this page