Create | HeyReach API Documentation

curl -X POST https://api/api/public/campaign/Create \
     -H "X-API-KEY: {{HR_API_KEY}}" \
     -H "Content-Type: application/json" \
     -d "{
  \"name\": \"My New Campaign\",
  \"linkedInUserListId\": 123456,
  \"linkedInAccountIds\": [
    11111,
    22222
  ],
  \"schedule\": {
    \"dailyStartTime\": \"09:00:00\",
    \"dailyEndTime\": \"17:00:00\",
    \"timeZoneId\": \"Europe/London\",
    \"enabledMonday\": true,
    \"enabledTuesday\": true,
    \"enabledWednesday\": true,
    \"enabledThursday\": true,
    \"enabledFriday\": true,
    \"enabledSaturday\": false,
    \"enabledSunday\": false,
    \"startDate\": null,
    \"endDate\": null
  },
  \"sequence\": {
    \"nodeType\": \"CONNECTION_REQUEST\",
    \"actionDelay\": 0,
    \"actionDelayUnit\": \"DAY\",
    \"payload\": {
      \"messages\": [
        \"Hi {FIRST_NAME}, I'd love to connect!\"
      ],
      \"fallbackMessage\": \"Hi there, I'd love to connect!\",
      \"toBeWithdrawnAfterDays\": 30
    },
    \"conditionalNode\": {
      \"nodeType\": \"MESSAGE\",
      \"actionDelay\": 2,
      \"actionDelayUnit\": \"DAY\",
      \"payload\": {
        \"messages\": [
          \"Thanks for connecting, {FIRST_NAME}!\"
        ],
        \"fallbackMessage\": \"Thanks for connecting!\"
      },
      \"unconditionalNode\": {
        \"nodeType\": \"SEND_LEAD_TO_BISON\",
        \"actionDelay\": 3,
        \"actionDelayUnit\": \"HOUR\",
        \"payload\": {
          \"bisonCampaignId\": {{bisonCampaignId}},
          \"stopExternalLead\": false
        },
        \"unconditionalNode\": {
          \"nodeType\": \"END\"
        }
      }
    },
    \"unconditionalNode\": {
      \"nodeType\": \"VIEW_PROFILE\",
      \"actionDelay\": 1,
      \"actionDelayUnit\": \"DAY\",
      \"unconditionalNode\": {
        \"nodeType\": \"END\",
        \"actionDelay\": 3,
        \"actionDelayUnit\": \"HOUR\"
      }
    }
  }
}"

Creates a campaign in DRAFT status.

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

Important: a campaign cannot be activated without a sequence. 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.
linkedInUserListId (long, required): ID of the lead list. Must exist and be of type USER_LIST.
linkedInAccountIds (int[], required): Sender LinkedIn account IDs. 1-100 items. All accounts must exist and have valid auth.
excludeContactedFromOtherCampaigns (bool, optional): Skip leads already in any other campaign. Default false.
excludeHasOtherAccConversations (bool, optional): Skip leads that already have conversations with other sender accounts. Default false.
excludeContactedFromSenderInOtherCampaign (bool, optional): Skip leads the sender accounts have already contacted in other campaigns. Default false.
excludeListId (long, optional): A separate list of leads to always exclude. Must not equal linkedInUserListId.
schedule (CampaignScheduleApiDto, optional): When the campaign runs. See UpdateSchedule for the object shape. If omitted, defaults to Mon-Fri 09:00-17:00 UTC.
sequence (PublicSequenceNodeDto, optional): The automation workflow. The START node is implicit - do not include it. See UpdateSequence for the object shape, the actionDelay rules, the SEND_LEAD_TO_* (Instantly / Smartlead / EmailBison) payload schemas, and the integration node errors - all of it applies identically here. Note that payload is required for CONNECTION_REQUEST, MESSAGE, INMAIL, LIKE_POST, SEND_LEAD_TO_INSTANTLY, SEND_LEAD_TO_SMARTLEAD and SEND_LEAD_TO_BISON nodes; omitting it is rejected with Error in the <NODE_TYPE> node of the campaign sequence. The required payload was not provided. Note: every node that follows an action step (including END nodes) must have actionDelay of at least 3 hours - use actionDelay: 3 with actionDelayUnit: "HOUR"; an omitted or 0 delay is rejected with Node at: ... has invalid delay: 00:00:00. If this parameter is omitted, add it via UpdateSequence before starting.

## Creates a campaign in DRAFT status. After the campaign is fully configured, call **StartCampaign** (`POST /api/public/campaign/StartCampaign?campaignId=`) to activate it. **Important:** a campaign cannot be activated without a sequence. 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. - **linkedInUserListId** _(long, required)_: ID of the lead list. Must exist and be of type USER_LIST. - **linkedInAccountIds** _(int\[\], required)_: Sender LinkedIn account IDs. 1-100 items. All accounts must exist and have valid auth. - **excludeContactedFromOtherCampaigns** _(bool, optional)_: Skip leads already in any other campaign. Default `false`. - **excludeHasOtherAccConversations** _(bool, optional)_: Skip leads that already have conversations with other sender accounts. Default `false`. - **excludeContactedFromSenderInOtherCampaign** _(bool, optional)_: Skip leads the sender accounts have already contacted in other campaigns. Default `false`. - **excludeListId** _(long, optional)_: A separate list of leads to always exclude. Must not equal `linkedInUserListId`. - **schedule** _(CampaignScheduleApiDto, optional)_: When the campaign runs. See **UpdateSchedule** for the object shape. If omitted, defaults to Mon-Fri 09:00-17:00 UTC. - **sequence** _(PublicSequenceNodeDto, optional)_: The automation workflow. The START node is implicit - do not include it. See **UpdateSequence** for the object shape, the `actionDelay` rules, the `SEND_LEAD_TO_*` (Instantly / Smartlead / EmailBison) payload schemas, and the integration node errors - all of it applies identically here. Note that `payload` is required for `CONNECTION_REQUEST`, `MESSAGE`, `INMAIL`, `LIKE_POST`, `SEND_LEAD_TO_INSTANTLY`, `SEND_LEAD_TO_SMARTLEAD` and `SEND_LEAD_TO_BISON` nodes; omitting it is rejected with `Error in the <NODE_TYPE> node of the campaign sequence. The required payload was not provided.` Note: every node that follows an action step (including `END` nodes) must have `actionDelay` of at least 3 hours - use `actionDelay: 3` with `actionDelayUnit: "HOUR"`; an omitted or `0` delay is rejected with `Node at: ... has invalid delay: 00:00:00`. If this parameter is omitted, add it via **UpdateSequence** before starting.

Request

This endpoint expects a string.

Response

campaignIdinteger

Creates a campaign in DRAFT status.

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

Body Parameters

name (string, required): The campaign name. 1-50 characters.

linkedInUserListId (long, required): ID of the lead list. Must exist and be of type USER_LIST.

linkedInAccountIds (int[], required): Sender LinkedIn account IDs. 1-100 items. All accounts must exist and have valid auth.

excludeContactedFromOtherCampaigns (bool, optional): Skip leads already in any other campaign. Default false.

excludeHasOtherAccConversations (bool, optional): Skip leads that already have conversations with other sender accounts. Default false.

excludeContactedFromSenderInOtherCampaign (bool, optional): Skip leads the sender accounts have already contacted in other campaigns. Default false.

excludeListId (long, optional): A separate list of leads to always exclude. Must not equal linkedInUserListId.

schedule (CampaignScheduleApiDto, optional): When the campaign runs. See UpdateSchedule for the object shape. If omitted, defaults to Mon-Fri 09:00-17:00 UTC.

sequence (PublicSequenceNodeDto, optional): The automation workflow. The START node is implicit - do not include it. See UpdateSequence for the object shape, the actionDelay rules, the SEND_LEAD_TO_* (Instantly / Smartlead / EmailBison) payload schemas, and the integration node errors - all of it applies identically here. Note that payload is required for CONNECTION_REQUEST, MESSAGE, INMAIL, LIKE_POST, SEND_LEAD_TO_INSTANTLY, SEND_LEAD_TO_SMARTLEAD and SEND_LEAD_TO_BISON nodes; omitting it is rejected with Error in the <NODE_TYPE> node of the campaign sequence. The required payload was not provided. Note: every node that follows an action step (including END nodes) must have actionDelay of at least 3 hours - use actionDelay: 3 with actionDelayUnit: "HOUR"; an omitted or 0 delay is rejected with Node at: ... has invalid delay: 00:00:00. If this parameter is omitted, add it via UpdateSequence before starting.

Creates a campaign in DRAFT status.

Body Parameters

Headers

Request

Response

Creates a campaign in DRAFT status.

Body Parameters