{"info":{"_postman_id":"fabb4f9d-2afd-46d8-9fce-23113ec8d7c5","name":"HeyReach API","description":"

Introduction

Welcome to the HeyReach API. Let' get started with a quick setup on how to use the API!

Finding your API key

The first step when using the HeyReach API is authenticating your requests with an API key.
The API key is used to authenticate the incoming requests and map them to your organization.
API keys never expire, however they can be deleted/deactivated.

Authentication

After you have your API key, you will need to provide it in every request that you make to the HeyReach API.
You will need to use add the X-API-KEY request header to every request and set you API key as the value.

Test your API key

Once you have your API key, you can check if it's working by sending the following request.
If everything is working properly, you should get a 200 HTTP status code.

curl --location &#x27;https://api.heyreach.io/api/public/auth/CheckApiKey&#x27; --header &#x27;X-API-KEY: <YOUR_API_KEY>&#x27;\n\n

Rate Limits

HeyReach allows a maximum of 300 requests per minute. All requests are attributed to the same limit.
Going above the limit will return a 429 HTTP status code and an error.

Enjoy building 🛠️

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23808049","collectionId":"fabb4f9d-2afd-46d8-9fce-23113ec8d7c5","publishedId":"2sA2xb5F75","public":true,"customColor":{"top-bar":"100f26","right-sidebar":"303030","highlight":"1c64f2"},"publishDate":"2024-03-01T11:29:43.000Z"},"item":[{"name":"PublicAuthentication","item":[{"name":"CheckApiKey","id":"96209d68-9333-4e86-a674-774eb7c4c5ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"//api/public/auth/CheckApiKey","description":"

Check If your API key is working.

\n","urlObject":{"path":["api","public","auth","CheckApiKey"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"dbd037df-05e6-4aca-857b-8eff2a4b2343","name":"Success","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""}],"url":"//api/public/auth/CheckApiKey"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"029781ea-4c16-47d0-b075-90136f98000c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"//api/public/auth/CheckApiKey"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"f0b48c92-cbdb-4337-bea7-856adf2be13d","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"//api/public/auth/CheckApiKey"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"96209d68-9333-4e86-a674-774eb7c4c5ee"}],"id":"ac5dd276-52d6-4cf2-a0ce-bd21d8766a7c","description":"

Check if your API token is set up properly

\n","_postman_id":"ac5dd276-52d6-4cf2-a0ce-bd21d8766a7c"},{"name":"PublicCampaigns","item":[{"name":"GetAll","id":"4aaf461e-54c4-4447-beb6-eb5ccca53fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": 0,\n \"keyword\": \"my campaign name\",\n \"statuses\": [\"DRAFT\", \"IN_PROGRESS\", \"PAUSED\", \"FINISHED\", \"CANCELED\", \"FAILED\", \"STARTING\", \"SCHEDULED\"],\n \"accountIds\": [123, 2, 5],\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/GetAll","description":"

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

\n","urlObject":{"path":["api","public","campaign","GetAll"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"f4133a3b-8036-47a6-9f97-07efdad4e1d9","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/GetAll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n }\n ]\n}"},{"id":"d85e8d5f-504b-4165-b490-aa1dc6289200","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/GetAll"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"43e605ad-a7d7-4da1-8054-d9ccd066fdcd","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/GetAll"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"144fbbde-8f35-4a88-9889-24991b1218ba","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"offset\": \"\",\n \"keyword\": \"\",\n \"statuses\": [\n null,\n null\n ],\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"limit\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/GetAll"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"4aaf461e-54c4-4447-beb6-eb5ccca53fb3"},{"name":"GetById","id":"ecf9b5c6-3bee-4437-83c7-0a4b4b269aae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"//api/public/campaign/GetById?campaignId=","description":"

Get a Campaign by id

\n","urlObject":{"path":["api","public","campaign","GetById"],"host":["/"],"query":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"6e38182b-a3d6-45e4-b71b-cba49171c747","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/GetById?campaignId=","host":["/"],"path":["api","public","campaign","GetById"],"query":[{"key":"campaignId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 274079,\n \"name\": \"My First Campaign\",\n \"creationTime\": \"2025-12-01T08:06:15.463169Z\",\n \"linkedInUserListName\": \"LinkedIn Ad BF Leads\",\n \"linkedInUserListId\": 123456,\n \"campaignAccountIds\": [\n 113298\n ],\n \"status\": \"IN_PROGRESS\",\n \"progressStats\": {\n \"totalUsers\": 9,\n \"totalUsersInProgress\": 8,\n \"totalUsersPending\": 0,\n \"totalUsersFinished\": 1,\n \"totalUsersFailed\": 0,\n \"totalUsersManuallyStopped\": 0,\n \"totalUsersExcluded\": 0\n },\n \"excludeInOtherCampaigns\": false,\n \"excludeHasOtherAccConversations\": false,\n \"excludeContactedFromSenderInOtherCampaign\": false,\n \"excludeListId\": null,\n \"organizationUnitId\": 12345\n}"},{"id":"f921d3a1-e721-4ee9-828e-4c13259f8562","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/GetById?campaignId=","host":["/"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"feac8b66-d7c4-4f68-9735-8ddbf4585e4b","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/GetById?campaignId=","host":["/"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"ff886d80-be5a-425e-9f2e-afc0ab7a4f05","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/GetById?campaignId=","host":["/"],"path":["api","public","campaign","GetById"],"query":[{"description":"(Required) ","key":"campaignId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"ecf9b5c6-3bee-4437-83c7-0a4b4b269aae"},{"name":"Resume","id":"af1c918e-e1e3-41c1-92bd-c6727dd80227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"//api/public/campaign/Resume?campaignId=","description":"

Resumes the specified campaign.

\n","urlObject":{"path":["api","public","campaign","Resume"],"host":["/"],"query":[{"description":{"content":"

(Required) The id of the campaign to be resumed

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[],"_postman_id":"af1c918e-e1e3-41c1-92bd-c6727dd80227"},{"name":"Pause","id":"9e750677-0d67-4511-a97a-b3740139744c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"//api/public/campaign/Pause?campaignId=","description":"

Pauses the specified campaign.

\n","urlObject":{"path":["api","public","campaign","Pause"],"host":["/"],"query":[{"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"15582de4-5af8-4327-a025-5d473359d1c7","name":"Success","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/Pause?campaignId=","host":["/"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"creationTime\": \"\",\n \"linkedInUserListName\": \"\",\n \"linkedInUserListId\": \"\",\n \"campaignAccountIds\": [\n \"\",\n \"\"\n ],\n \"status\": null,\n \"progressStats\": {\n \"totalUsers\": \"\",\n \"totalUsersInProgress\": \"\",\n \"totalUsersPending\": \"\",\n \"totalUsersFinished\": \"\",\n \"totalUsersFailed\": \"\"\n },\n \"excludeAlreadyMessagedGlobal\": \"\",\n \"excludeAlreadyMessagedCampaignAccounts\": \"\",\n \"excludeFirstConnectionCampaignAccounts\": \"\",\n \"excludeFirstConnectionGlobal\": \"\",\n \"excludeNoProfilePicture\": \"\",\n \"excludeListId\": \"\"\n }\n ]\n}"},{"id":"53778958-4cbf-4298-9d8d-f4eadd887fb4","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/Pause?campaignId=","host":["/"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"678dca57-348f-4cbf-bb2f-2dfe9e26fd06","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/Pause?campaignId=","host":["/"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"984c214b-afd5-4d8f-aec8-2882b3db7b08","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/Pause?campaignId=","host":["/"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"ebe6b907-64d1-47c7-8e98-e2c012dc5523","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/Pause?campaignId=","host":["/"],"path":["api","public","campaign","Pause"],"query":[{"description":"(Required) The id of the campaign to be paused","key":"campaignId","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"9e750677-0d67-4511-a97a-b3740139744c"},{"name":"AddLeadsToCampaign","id":"b0d7923a-2193-40fb-80be-6300a0ebafc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"salama","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign","description":"

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.

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.

\n","urlObject":{"path":["api","public","campaign","AddLeadsToCampaign"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"fea98502-b046-4d21-a41e-5bfd49ee44b7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\",\n \"resumeFinishedCampaign\": \"\",\n \"resumePausedCampaign\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"0"},{"id":"c915fe08-e7f8-4425-8def-93b30220c9a2","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"1c5d62e2-88c0-475c-8028-ddaa47f1457a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"d9fd54b8-5bb7-45b6-b81e-f319144019a7","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"5dc7227c-94e3-494b-93eb-3a3c71db0326","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaign"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"b0d7923a-2193-40fb-80be-6300a0ebafc3"},{"name":"AddLeadsToCampaignV2","id":"9071e40e-3f6f-473c-b107-b07d36c25d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"salama","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

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. Same as the AddLeadsToCampaign 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.

\n","urlObject":{"path":["api","public","campaign","AddLeadsToCampaignV2"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"df58f4e3-3a58-4f67-a1d9-8d4be053d8a1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\",\n \"resumeFinishedCampaign\": \"\",\n \"resumePausedCampaign\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaignV2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"addedLeadsCount\": 10,\n \"updatedLeadsCount\": 1,\n \"failedLeadsCount\": 0\n}"},{"id":"cda13e05-aaff-4705-b090-703a9c483d12","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaignV2"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"adb73bb6-af3f-4dc5-9c8f-6def29326bf5","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaignV2"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"},{"id":"9fcb797f-9763-40fb-9031-29f41a25cb5a","name":"Not Found","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaignV2"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"1cde296b-005d-4b17-ac0a-453ac1a87b48","name":"Too Many Requests","originalRequest":{"method":"POST","header":[{"description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"","key":"X-API-KEY","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"accountLeadPairs\": [\n {\n \"lead\": {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"profileUrl\": \"\",\n \"location\": \"\",\n \"summary\": \"\",\n \"companyName\": \"\",\n \"position\": \"\",\n \"about\": \"\",\n \"emailAddress\": \"\",\n \"customUserFields\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"linkedInAccountId\": \"\"\n }\n ],\n \"campaignId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/AddLeadsToCampaignV2"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"ut8c\": {},\n \"laborum__e5\": {},\n \"occaecat100\": {}\n}"}],"_postman_id":"9071e40e-3f6f-473c-b107-b07d36c25d29"},{"name":"StopLeadInCampaign","id":"c744e1f5-df47-48b2-af7f-f2916205124e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 123,\r\n \"leadMemberId\": \"123123123\",\r\n \"leadUrl\": \"https://www.linkedin.com/in/john-doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/StopLeadInCampaign","description":"

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.
\n
leadMemberId: The lead member Id. You can get the member Id from the field 'linkedin_id' in the method 'GetLeadsFromCampaign' or from 'GetLeadsFromList'
\n
leadUrl: the linked in URL for the lead
\n

\n","urlObject":{"path":["api","public","campaign","StopLeadInCampaign"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"e47b79f8-0a79-4282-bcde-878f98dc7685","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 123,\r\n \"leadMemberId\": null,\r\n \"leadUrl\": \"https://www.linkedin.com/in/john-doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/StopLeadInCampaign"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c744e1f5-df47-48b2-af7f-f2916205124e"},{"name":"GetLeadsFromCampaign","id":"eec5fce8-0466-4a55-8b37-2badb1e7210c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 1805\r\n ,\"offset\": 0\r\n ,\"limit\": 100\r\n ,\"timeFrom\": \"2024-10-06T17:34:00+02:00\"\r\n ,\"timeTo\": \"2024-10-07T17:36:00+02:00\"\r\n ,\"timeFilter\": \"CreationTime\"\r\n //,\"timeFilter\": \"Everywhere\" \r\n //,\"timeFilter\": \"LastActionTakenTime\" \r\n //,\"timeFilter\": \"FailedTime\" \r\n //,\"timeFilter\": \"LastActionTakenOrFailedTime\" \r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/GetLeadsFromCampaign","description":"

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. There might be more \"Pending\" leads from the specified lead list, that the system will insert later for execution.

Body Parameters

campaignId (integer): The ID of the campaign.
\n
offset (integer): The number of records to skip (for pagination).
\n
limit (integer): The maximum number of records to return.
\n
timeFrom (string, ISO 8601): The start of the time range for filtering.
\n
timeTo (string, ISO 8601): The end of the time range for filtering.
\n
timeFilter (string): Defines the time filter for fetching leads. Possible values:
\n
- CreationTime: Filters leads by their creation time.
  \n
- Everywhere: No specific time filtering is applied. (Default behavior if omitted)
  \n
- LastActionTakenTime: Filters leads that executed an action within the given time range
  \n
- FailedTime: Filters leads that executed an action within the given time range
  \n
- LastActionTakenOrFailedTime: Filters leads that executed an action OR failed within the given time range
  \n
\n

Response:

LeadCampaignStatus

Pending
\n
InSequence
\n
Finished
\n
Paused
\n
Failed
\n

LeadConnectionStatus

None
\n
ConnectionSent
\n
ConnectionAccepted
\n

LeadMessageStatus

None
\n
MessageSent
\n
MessageReply
\n

LeadStatusMessage (string)

Usually null, but if the lead is in Failed status, this shows the reason why the lead failed.

\n","urlObject":{"path":["api","public","campaign","GetLeadsFromCampaign"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"cf294fa9-2b52-4116-95ac-bbc087f43271","name":"GetLeadsFromCampaign","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignId\": 1805\r\n ,\"offset\": 0\r\n ,\"limit\": 100\r\n ,\"timeFrom\": \"2024-10-06T17:34:00+02:00\"\r\n ,\"timeTo\": \"2024-10-07T17:36:00+02:00\"\r\n ,\"timeFilter\": \"CreationTime\"\r\n //,\"timeFilter\": \"Everywhere\" \r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/GetLeadsFromCampaign"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 152,\r\n \"items\": [\r\n {\r\n \"id\": 62658,\r\n \"linkedInUserProfileId\": \"AC9sANasasasX0Ia-q6DQxyS35UD7a8716G5c8\",\r\n \"linkedInUserProfile\": {\r\n \"linkedin_id\": \"58344979\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/johndoe\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"headline\": \"Communications and Marketing Professional\",\r\n \"imageUrl\": \"https://media.licdn.com/dms/image/v2/D4E03AQH0WJHn5rNRpA/profile-displayphoto-shrink_100_100/profile-displayphoto-shrink_100_100/0/1671ss497?e=173ss&\",\r\n \"location\": \"Princetown\",\r\n \"companyName\": \"ACME\",\r\n \"companyUrl\": null,\r\n \"position\": \"\",\r\n \"about\": null,\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"emailAddress\": null\r\n },\r\n \"lastActionTime\": \"2024-10-01T03:28:22.414791Z\",\r\n \"failedTime\": null,\r\n \"creationTime\": \"2024-09-30T21:28:06.933349Z\",\r\n \"leadCampaignStatus\": \"Finished\",\r\n \"leadConnectionStatus\": \"None\",\r\n \"leadMessageStatus\": \"None\",\r\n \"errorCode\": null,\r\n \"leadCampaignStatusMessage\": null,\r\n \"linkedInSenderId\": 1108,\r\n \"linkedInSenderFullName\": \"Jane Doe\"\r\n } \r\n ]\r\n}"}],"_postman_id":"eec5fce8-0466-4a55-8b37-2badb1e7210c"},{"name":"GetCampaignsForLead","id":"380f09d2-5c98-4f09-ba18-2909d1e6c026","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"string\",\r\n \"linkedinId\": \"string\",\r\n \"profileUrl\": \"string\",\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/GetCampaignsForLead","description":"

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.

Body Parameters

email (string, optional): The email address of the lead.
\n
linkedinId (string, optional): The LinkedIn ID of the lead.
\n
profileUrl (string, optional): The LinkedIn profile URL of the lead.
\n
for example: https://www.linkedin.com/in/john_doe/
\n
offset (integer): The number of records to skip (for pagination).
\n
limit (integer): The maximum number of records to return.
\n

Response:

LeadStatus

Pending
\n
InSequence
\n
Finished
\n
Paused
\n
Failed
\n
Excluded
\n
PendingOrExcludedToBeCalculated
\n

CampaignStatus

DRAFT
\n
IN_PROGRESS
\n
PAUSED
\n
FINISHED
\n
CANCELED
\n
FAILED
\n
STARTING
\n

\n","urlObject":{"path":["api","public","campaign","GetCampaignsForLead"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"2466d366-1c73-4f11-9fc1-a7cc37d19082","name":"GeCampaignsForLead","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"john_doe@example.com\",\r\n \"linkedinId\": \"1254asd3\",\r\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe\",\r\n \"offset\": 0,\r\n \"limit\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"//api/public/campaign/GetCampaignsForLead"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"leadFullName\": \"John Doe\",\r\n \"totalCount\": 2,\r\n \"items\": [\r\n {\r\n \"campaignId\": 1082,\r\n \"campaignName\": \"Campaign For Veterans\",\r\n \"campaignStatus\": \"PAUSED\",\r\n \"creationTime\": \"2025-11-12T13:22:29.96342Z\",\r\n \"leadStatus\": \"Finished\"\r\n },\r\n {\r\n \"campaignId\": 1451,\r\n \"campaignName\": \"Campaign 5\",\r\n \"campaignStatus\": \"CANCELED\",\r\n \"creationTime\": \"2025-10-12T13:22:29.96342Z\",\r\n \"leadStatus\": \"Finished\"\r\n }\r\n ]\r\n}"}],"_postman_id":"380f09d2-5c98-4f09-ba18-2909d1e6c026"},{"name":"StartCampaign","id":"0612567a-a90b-4417-a23f-e3bc466c4ba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"//api/public/campaign/StartCampaign?campaignId=","description":"

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.

Query Parameters

campaignId (long, required): The ID of the campaign to activate.

Errors

400: Campaign is in an invalid status, the schedule is invalid, or the lead list / accounts are not usable.
\n
404: Campaign does not exist.
\n

\n","urlObject":{"path":["api","public","campaign","StartCampaign"],"host":["/"],"query":[{"description":{"content":"

(Required) The id of the campaign to activate.

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"b0b7f5b2-f0e8-4a42-9ff6-9124644168f9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/StartCampaign?campaignId=","host":["/"],"path":["api","public","campaign","StartCampaign"],"query":[{"key":"campaignId","value":"","description":"(Required) The id of the campaign to activate."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0612567a-a90b-4417-a23f-e3bc466c4ba1"},{"name":"UpdateSettings","id":"db605a18-3177-4300-9b1a-01f545215a6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"name\": \"Renamed Campaign\",\n \"linkedInUserListId\": 123456,\n \"excludeContactedFromOtherCampaigns\": false,\n \"excludeHasOtherAccConversations\": false,\n \"excludeContactedFromSenderInOtherCampaign\": false,\n \"excludeListId\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSettings","description":"

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. IN_PROGRESS, FINISHED). If the campaign was SCHEDULED, it reverts to DRAFT.

Important: this is a full replacement of the settings below - every exclusion field you omit from the body will be reset to its default (false for booleans, null for excludeListId). Always send the complete set of exclusion settings you want, not a partial diff.

Body Parameters

campaignId (long, required): The campaign to update.
\n
name (string, required): New campaign name. 1-50 characters.
\n
linkedInUserListId (long, required): Replacement lead list ID. Must be of type USER_LIST. Cannot be changed once the campaign has been started at least once.
\n
excludeContactedFromOtherCampaigns (bool, optional): Default false.
\n
excludeHasOtherAccConversations (bool, optional): Default false.
\n
excludeContactedFromSenderInOtherCampaign (bool, optional): Default false.
\n
excludeListId (long, optional): Must not equal linkedInUserListId.
\n

\n","urlObject":{"path":["api","public","campaign","UpdateSettings"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7b8256aa-c67a-4053-9332-e15126138f3c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"name\": \"Renamed Campaign\",\n \"linkedInUserListId\": 123456,\n \"excludeContactedFromOtherCampaigns\": false,\n \"excludeHasOtherAccConversations\": false,\n \"excludeContactedFromSenderInOtherCampaign\": false,\n \"excludeListId\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSettings"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"db605a18-3177-4300-9b1a-01f545215a6a"},{"name":"UpdateSchedule","id":"0777c6e4-f07e-45b4-8ac1-4805f15e169c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"schedule\": {\n \"dailyStartTime\": \"09:00:00\",\n \"dailyEndTime\": \"17:00:00\",\n \"timeZoneId\": \"Etc/GMT\",\n \"enabledMonday\": true,\n \"enabledTuesday\": true,\n \"enabledWednesday\": true,\n \"enabledThursday\": true,\n \"enabledFriday\": true,\n \"enabledSaturday\": false,\n \"enabledSunday\": false,\n \"startDate\": null,\n \"endDate\": null\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSchedule","description":"

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. IN_PROGRESS, FINISHED). For SCHEDULED campaigns the campaign reverts to DRAFT. Once a campaign has been started at least once, startDate cannot be changed.

Body Parameters

campaignId (long, required): The campaign to update.
\n
schedule (CampaignScheduleApiDto, required): The new schedule configuration.
\n

CampaignScheduleApiDto fields

dailyStartTime (TimeSpan, required): Start of the daily active window, format \"HH:mm:ss\" (e.g. \"09:00:00\"). Must be before dailyEndTime. Maximum is 24 hours - see note below.
\n
dailyEndTime (TimeSpan, required): End of the daily active window, format \"HH:mm:ss\" (e.g. \"17:00:00\"). Must be after dailyStartTime. Maximum is 24 hours - see note below.
\n
timeZoneId (string, required): IANA timezone identifier (e.g. \"America/New_York\", \"Europe/London\"). Default \"Etc/GMT\".
\n
enabledMonday (bool, optional): Default true.
\n
enabledTuesday (bool, optional): Default true.
\n
enabledWednesday (bool, optional): Default true.
\n
enabledThursday (bool, optional): Default true.
\n
enabledFriday (bool, optional): Default true.
\n
enabledSaturday (bool, optional): Default false.
\n
enabledSunday (bool, optional): Default false.
\n
startDate (date, optional): ISO date, e.g. \"2025-06-01\". If null or in the past, the campaign starts immediately when activated. Cannot be modified after the campaign has been started.
\n
endDate (date, optional): ISO date. Campaign stops automatically on this date. Must be after startDate if both are set.
\n

At least one enabled* day must be true.

Note on the 24-hour boundary: the maximum is 24 hours and is sent as \"24:00:00\" (interpreted as end-of-day in the campaign's timeZoneId). Some client libraries (e.g. Python's datetime.strptime with %H:%M:%S) reject hours outside 0-23. If yours does, send \"23:59:59\" instead.

\n","urlObject":{"path":["api","public","campaign","UpdateSchedule"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"3ce8dbc3-6e08-444a-989d-a06aa3d5d8bc","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"schedule\": {\n \"dailyStartTime\": \"09:00:00\",\n \"dailyEndTime\": \"17:00:00\",\n \"timeZoneId\": \"Etc/GMT\",\n \"enabledMonday\": true,\n \"enabledTuesday\": true,\n \"enabledWednesday\": true,\n \"enabledThursday\": true,\n \"enabledFriday\": true,\n \"enabledSaturday\": false,\n \"enabledSunday\": false,\n \"startDate\": null,\n \"endDate\": null\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSchedule"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0777c6e4-f07e-45b4-8ac1-4805f15e169c"},{"name":"UpdateAccounts","id":"93c053b6-6ef3-4474-8032-3dd45358036f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"linkedInAccountIds\": [\n 11111,\n 22222\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateAccounts","description":"

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.

Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). For SCHEDULED campaigns the campaign reverts to DRAFT.

Body Parameters

campaignId (long, required): The campaign to update.
\n
linkedInAccountIds (int[], required): Full replacement list of sender account IDs. 1-100 items. All accounts must exist and have valid auth.
\n

\n","urlObject":{"path":["api","public","campaign","UpdateAccounts"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"9ffb9b66-5c42-40f1-a902-6c23895c5ddd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"linkedInAccountIds\": [\n 11111,\n 22222\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateAccounts"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"93c053b6-6ef3-4474-8032-3dd45358036f"},{"name":"Create","id":"70563ca0-4cc8-482d-b129-37b4142d9526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My New Campaign\",\n \"linkedInUserListId\": 123456,\n \"linkedInAccountIds\": [\n 11111,\n 22222\n ],\n \"schedule\": {\n \"dailyStartTime\": \"09:00:00\",\n \"dailyEndTime\": \"17:00:00\",\n \"timeZoneId\": \"Europe/London\",\n \"enabledMonday\": true,\n \"enabledTuesday\": true,\n \"enabledWednesday\": true,\n \"enabledThursday\": true,\n \"enabledFriday\": true,\n \"enabledSaturday\": false,\n \"enabledSunday\": false,\n \"startDate\": null,\n \"endDate\": null\n },\n \"sequence\": {\n \"nodeType\": \"CONNECTION_REQUEST\",\n \"actionDelay\": 0,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Hi {FIRST_NAME}, I'd love to connect!\"\n ],\n \"fallbackMessage\": \"Hi there, I'd love to connect!\",\n \"toBeWithdrawnAfterDays\": 30\n },\n \"conditionalNode\": {\n \"nodeType\": \"MESSAGE\",\n \"actionDelay\": 2,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Thanks for connecting, {FIRST_NAME}!\"\n ],\n \"fallbackMessage\": \"Thanks for connecting!\"\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n },\n \"unconditionalNode\": {\n \"nodeType\": \"VIEW_PROFILE\",\n \"actionDelay\": 1,\n \"actionDelayUnit\": \"DAY\",\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/Create","description":"

Creates a campaign in DRAFT status.

After the campaign is fully configured, call StartCampaign (POST /api/public/campaign/StartCampaign?campaignId=<id>) to activate it.

Important: a campaign cannot be activated without a sequence. The example body below includes a sample schedule and sequence; if you omit sequence from your own call, you must add one via UpdateSequence before StartCampaign will succeed.

Body Parameters

name (string, required): The campaign name. 1-50 characters.
\n
linkedInUserListId (long, required): ID of the lead list. Must exist and be of type USER_LIST.
\n
linkedInAccountIds (int[], required): Sender LinkedIn account IDs. 1-100 items. All accounts must exist and have valid auth.
\n
excludeContactedFromOtherCampaigns (bool, optional): Skip leads already in any other campaign. Default false.
\n
excludeHasOtherAccConversations (bool, optional): Skip leads that already have conversations with other sender accounts. Default false.
\n
excludeContactedFromSenderInOtherCampaign (bool, optional): Skip leads the sender accounts have already contacted in other campaigns. Default false.
\n
excludeListId (long, optional): A separate list of leads to always exclude. Must not equal linkedInUserListId.
\n
schedule (CampaignScheduleApiDto, optional): When the campaign runs. See UpdateSchedule for the object shape. If omitted, defaults to Mon-Fri 09:00-17:00 UTC.
\n
sequence (PublicSequenceNodeDto, optional): The automation workflow. The START node is implicit - do not include it. See UpdateSequence for the object shape. If omitted, add it via UpdateSequence before starting.
\n

\n","urlObject":{"path":["api","public","campaign","Create"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"d50bc279-485e-4acf-b2dc-79a89df3706c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My New Campaign\",\n \"linkedInUserListId\": 123456,\n \"linkedInAccountIds\": [\n 11111,\n 22222\n ],\n \"schedule\": {\n \"dailyStartTime\": \"09:00:00\",\n \"dailyEndTime\": \"17:00:00\",\n \"timeZoneId\": \"Europe/London\",\n \"enabledMonday\": true,\n \"enabledTuesday\": true,\n \"enabledWednesday\": true,\n \"enabledThursday\": true,\n \"enabledFriday\": true,\n \"enabledSaturday\": false,\n \"enabledSunday\": false,\n \"startDate\": null,\n \"endDate\": null\n },\n \"sequence\": {\n \"nodeType\": \"CONNECTION_REQUEST\",\n \"actionDelay\": 0,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Hi {FIRST_NAME}, I'd love to connect!\"\n ],\n \"fallbackMessage\": \"Hi there, I'd love to connect!\",\n \"toBeWithdrawnAfterDays\": 30\n },\n \"conditionalNode\": {\n \"nodeType\": \"MESSAGE\",\n \"actionDelay\": 2,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Thanks for connecting, {FIRST_NAME}!\"\n ],\n \"fallbackMessage\": \"Thanks for connecting!\"\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n },\n \"unconditionalNode\": {\n \"nodeType\": \"VIEW_PROFILE\",\n \"actionDelay\": 1,\n \"actionDelayUnit\": \"DAY\",\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/Create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"campaignId\": 12345\n}"}],"_postman_id":"70563ca0-4cc8-482d-b129-37b4142d9526"},{"name":"UpdateSequence","id":"eeb60b20-3de0-4504-853f-13bc79ed01d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"sequence\": {\n \"nodeType\": \"CONNECTION_REQUEST\",\n \"actionDelay\": 0,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Hi {FIRST_NAME}, I'd love to connect!\"\n ],\n \"fallbackMessage\": \"Hi there, I'd love to connect!\",\n \"toBeWithdrawnAfterDays\": 30\n },\n \"conditionalNode\": {\n \"nodeType\": \"MESSAGE\",\n \"actionDelay\": 2,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Thanks for connecting, {FIRST_NAME}!\"\n ],\n \"fallbackMessage\": \"Thanks for connecting!\"\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSequence","description":"

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. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). For PAUSED campaigns a safe update is performed - existing lead states are preserved and leads are remapped to compatible positions in the new sequence. For SCHEDULED campaigns the campaign reverts to DRAFT.

Body Parameters

campaignId (long, required): The campaign to update.
\n
sequence (PublicSequenceNodeDto, required): Root node of the workflow tree.
\n

PublicSequenceNodeDto fields

nodeType (string, required): One of CONNECTION_REQUEST, MESSAGE, INMAIL, VIEW_PROFILE, FOLLOW, LIKE_POST, FIND_EMAIL, CHECK_IS_CONNECTION, CHECK_IS_OPEN_PROFILE, SEND_LEAD_TO_INSTANTLY, SEND_LEAD_TO_SMARTLEAD, SEND_LEAD_TO_BISON, END.
\n
unconditionalNode (PublicSequenceNodeDto, required for non-END nodes): The next node to follow unconditionally, or when a branching condition is false.
\n
conditionalNode (PublicSequenceNodeDto, required for branching nodes): The next node to follow when the branching condition is true. Branching nodes are CONNECTION_REQUEST, CHECK_IS_CONNECTION, CHECK_IS_OPEN_PROFILE, FIND_EMAIL. All other non-END nodes must NOT set this field.
\n
actionDelay (int, optional): How long to wait before executing this node, paired with actionDelayUnit. Range 0-100. Recommended default for non-root nodes: actionDelay: 3 with actionDelayUnit: \"HOUR\" - that is the minimum the server accepts when the parent is in the list below. The resulting delay (actionDelay x actionDelayUnit) must be at least 3 hours and not more than 500 days if the parent is in the list - this applies to every node type, including END. Parents that require the minimum on their unconditional child: CONNECTION_REQUEST, MESSAGE, INMAIL, VIEW_PROFILE, FOLLOW, LIKE_POST. Parents that require the minimum on their conditional child: CONNECTION_REQUEST. The root node has no parent and may use 0.
\n
actionDelayUnit (string, optional): Unit for actionDelay. HOUR or DAY.
\n
payload (object, conditional): Schema is node-specific - the shape of payload depends on nodeType, it is NOT a shared object. Required for action nodes that take configuration: CONNECTION_REQUEST, MESSAGE, INMAIL, LIKE_POST, SEND_LEAD_TO_INSTANTLY, SEND_LEAD_TO_SMARTLEAD, SEND_LEAD_TO_BISON. Not used for action-only nodes: VIEW_PROFILE, FOLLOW, FIND_EMAIL, CHECK_IS_CONNECTION, CHECK_IS_OPEN_PROFILE, END. Refer to the API documentation for the exact schema per node type.
\n
externalReference (string, optional): Your own tracking ID for this step, returned via API and webhooks. Max 100 characters.
\n

\n","urlObject":{"path":["api","public","campaign","UpdateSequence"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"3ccf097c-4d16-4562-bc01-9bab3b97c60c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"campaignId\": 12345,\n \"sequence\": {\n \"nodeType\": \"CONNECTION_REQUEST\",\n \"actionDelay\": 0,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Hi {FIRST_NAME}, I'd love to connect!\"\n ],\n \"fallbackMessage\": \"Hi there, I'd love to connect!\",\n \"toBeWithdrawnAfterDays\": 30\n },\n \"conditionalNode\": {\n \"nodeType\": \"MESSAGE\",\n \"actionDelay\": 2,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Thanks for connecting, {FIRST_NAME}!\"\n ],\n \"fallbackMessage\": \"Thanks for connecting!\"\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/campaign/UpdateSequence"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eeb60b20-3de0-4504-853f-13bc79ed01d4"},{"name":"GetCampaignSequence","id":"7a0b6a65-d30b-4d07-8a2c-e7ce42e03fb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Accept","value":"text/plain"}],"url":"//api/public/campaign/GetCampaignSequence?campaignId=","description":"

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. Returns an empty 200 response if the campaign has no sequence.

Query Parameters

campaignId (long, required): The campaign whose sequence to retrieve.

\n","urlObject":{"path":["api","public","campaign","GetCampaignSequence"],"host":["/"],"query":[{"description":{"content":"

(Required) The campaign whose sequence to retrieve

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[{"id":"c0d8cf7e-473e-4fe3-adcb-61379f1fa161","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{HR_API_KEY}}","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/campaign/GetCampaignSequence?campaignId=","host":["/"],"path":["api","public","campaign","GetCampaignSequence"],"query":[{"key":"campaignId","value":"","description":"(Required) The campaign whose sequence to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"nodeType\": \"CONNECTION_REQUEST\",\n \"actionDelay\": 0,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Hi {FIRST_NAME}, I'd love to connect!\"\n ],\n \"fallbackMessage\": \"Hi there, I'd love to connect!\",\n \"toBeWithdrawnAfterDays\": 30\n },\n \"conditionalNode\": {\n \"nodeType\": \"MESSAGE\",\n \"actionDelay\": 2,\n \"actionDelayUnit\": \"DAY\",\n \"payload\": {\n \"messages\": [\n \"Thanks for connecting, {FIRST_NAME}!\"\n ],\n \"fallbackMessage\": \"Thanks for connecting!\"\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n },\n \"unconditionalNode\": {\n \"nodeType\": \"END\",\n \"actionDelay\": 3,\n \"actionDelayUnit\": \"HOUR\"\n }\n}"}],"_postman_id":"7a0b6a65-d30b-4d07-8a2c-e7ce42e03fb4"}],"id":"cfef6f03-7c75-40ec-9d0e-dec65ebd3830","description":"

Methods for working with HeyReach campaigns. Filter, pause resume and manage leads inside your campaigns.

\n","_postman_id":"cfef6f03-7c75-40ec-9d0e-dec65ebd3830"},{"name":"PublicInbox","item":[{"name":"GetConversationsV2","id":"c76026be-43e7-44ba-8776-1748007fa22d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"filters\": {\n \"linkedInAccountIds\": [],\n \"campaignIds\": [],\n \"searchString\": \"\",\n \"leadLinkedInId\": \"\",\n \"leadProfileUrl\": \"https://www.linkedin.com/in/john_doe/\",\n \"tags\": [\n \"Lead tag1\",\n \"Lead Tag2\"\n ],\n \"seen\": null\n },\n \"offset\": 0,\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/inbox/GetConversationsV2","description":"

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

Body Parameters

filters
\n
- linkedInAccountIds (int[]): The ids of the LinkedIn senders
  \n
- campaignIds (int[])
  \n
- searchString (string, optional)
  \n
- leadLinkedInId (string, optional) - The LinkedIn ID of the lead. You can find this ID as \"linkedin_id\" in the response of many of our endpoints, for example in the '/api/public/lead/GetLead' endpoint.
  \n
- leadProfileUrl (string, optional) - The linkedin URL of the lead
  \n
- searchString (string, optional)
  \n
- tags - case-insensitive list of lead's tags. Only the conversations of the leads that have at least one of the tags will be exported.
  \n
- seen (boolean. optional)
  \n
\n

\n","urlObject":{"path":["api","public","inbox","GetConversationsV2"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"82c6828b-9b76-4468-83ad-66027e76ff96","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"filters\": {\n \"linkedInAccountIds\": [ \n ],\n \"campaignIds\": [ \n ],\n \"searchString\": \"string\",\n \"leadLinkedInId\": \"string\",\n \"leadProfileUrl\": \"string\",\n \"tags\": [\n \"Lead tag1\",\n \"Lead Tag2\"\n ],\n \"seen\": null | true | false\n },\n \"offset\": 0,\n \"limit\": 10\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/public/inbox/GetConversationsV2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"totalCount\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"string\",\r\n \"read\": true,\r\n \"groupChat\": true,\r\n \"blockedByMe\": true,\r\n \"blockedByParticipant\": true,\r\n \"lastMessageAt\": \"2025-03-28T12:00:19.007Z\",\r\n \"lastMessageText\": \"string\",\r\n \"lastMessageType\": \"TEXT\",\r\n \"lastMessageSender\": \"ME\",\r\n \"totalMessages\": 0, \r\n \"linkedInAccountId\": 0,\r\n \"correspondentProfile\": {\r\n \"id\": \"string\",\r\n \"linkedin_id\": \"string\",\r\n \"profileUrl\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"headline\": \"string\",\r\n \"imageUrl\": \"string\",\r\n \"location\": \"string\",\r\n \"companyName\": \"string\",\r\n \"companyUrl\": \"string\",\r\n \"position\": \"string\",\r\n \"about\": \"string\",\r\n \"connections\": 0,\r\n \"followers\": 0,\r\n \"tags\": [\r\n \"string\"\r\n ],\r\n \"emailAddress\": \"string\",\r\n \"customFields\": [\r\n {\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ]\r\n },\r\n \"linkedInAccount\": {\r\n \"id\": 0,\r\n \"emailAddress\": \"string\",\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"authIsValid\": true,\r\n \"isValidNavigator\": true,\r\n \"isValidRecruiter\": true,\r\n \"profileUrl\": \"https://www.linkedin.com/in/john_doe-12b36a384\"\r\n },\r\n \"messages\": [\r\n {\r\n \"createdAt\": \"2025-03-28T12:00:19.007Z\",\r\n \"body\": \"string\",\r\n \"subject\": \"string\",\r\n \"postLink\": \"string\",\r\n \"isInMail\": true,\r\n \"sender\": \"ME\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"c76026be-43e7-44ba-8776-1748007fa22d"},{"name":"GetChatroom","id":"4476f6de-4085-4418-98fb-61661149696a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\"

\n","key":"X-API-KEY","value":""},{"key":"Accept","value":"text/plain"}],"url":"//api/public/inbox/GetChatroom/:accountId/:conversationId","description":"

Get a LinkedIn conversation with its messages by Id.

\n","urlObject":{"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"host":["/"],"query":[],"variable":[{"id":"6bab4375-cd03-4f80-b973-953ac9e5fc94","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"accountId"},{"id":"09b4f17d-1f62-400b-85a1-77e40e31260c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"conversationId"}]}},"response":[{"id":"f5323f5e-f216-4bc8-8241-50238480f9a6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","description":"API key header using this scheme. Example: \"X-API-KEY: {API_KEY}\""},{"key":"Accept","value":"text/plain"}],"url":{"raw":"//api/public/inbox/GetChatroom/:accountId/:conversationId","host":["/"],"path":["api","public","inbox","GetChatroom",":accountId",":conversationId"],"variable":[{"key":"accountId","value":""},{"key":"conversationId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"read\": \"\",\n \"groupChat\": \"\",\n \"blockedByMe\": \"\",\n \"blockedByParticipant\": \"\",\n \"lastMessageAt\": \"\",\n \"lastMessageText\": \"\",\n \"lastMessageSender\": null,\n \"totalMessages\": \"\", \n \"linkedInAccountId\": \"\",\n \"correspondentProfile\": {\n \"profileUrl\": \"\",\n \"firstName\": \"

Introduction

Finding your API key

Authentication

Test your API key

Rate Limits

Enjoy building 🛠️

Stops a lead in a campaign

Body Parameters

Gets the leads that are in a campaign.

Body Parameters

Response:

LeadCampaignStatus

LeadConnectionStatus

LeadMessageStatus

LeadStatusMessage (string)

Gets Campaigns for a Lead

Body Parameters

Response:

LeadStatus

CampaignStatus

Activates a campaign that was created via Create.

Query Parameters

Errors

Updates the general settings of a campaign: name, lead list, and exclusion options.

Body Parameters

Replaces the schedule of a campaign.

Body Parameters

CampaignScheduleApiDto fields

Replaces the entire list of LinkedIn sender accounts assigned to a campaign.

Body Parameters

Creates a campaign in DRAFT status.

Body Parameters

Creates or fully replaces the sequence (workflow) of a campaign.

Body Parameters

PublicSequenceNodeDto fields

Retrieves the current sequence (workflow) of a campaign as a PublicSequenceNodeDto.

Query Parameters

Body Parameters

Deletes the specified leads from a lead list.

Params:

Deletes the specified leads from a lead list by LinkedIn profile url.

Params:

Gets Lists for a Lead

Body Parameters

Gets the overall stats for the specified filters.

Request Body

Gets Lead Details

Body Parameters

Add Tags to Lead

Get Tags for a Lead

Replaces Tags to Lead

Create Webhook

Request Body Example

Request Parameters

Get Webhook By Id

Get All Webhooks

Update Webhook

Query Parameters

Request Body Example

Request Parameters

Delete Webhook

Query Parameters

GetMyNetworkForSender

Request Body Example

Request Parameters

IsConnection

Request Body Example

Request Parameters

Organization Management API

Finding your Organization API key

Rate Limits