Campaigns

CreateCampaignFromTemplate

Creates a new campaign by cloning the sequence and schedule of an existing campaign (the template).

The new campaign is created in DRAFT status. The sequence (workflow) and schedule are copied from the template campaign identified by campaignIdForTemplate; you supply the new name, lead list, sender accounts and exclude options. After creation, call StartCampaign (POST /api/public/campaign/StartCampaign?campaignId=<id>) to activate it.

Body Parameters

  • campaignIdForTemplate (long, required): ID of the existing campaign to use as the template. Its sequence and schedule are copied to the new campaign.

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

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

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

  • excludeContactedFromOtherCampaigns (bool, required): Skip leads already in any other campaign.

  • excludeHasOtherAccConversations (bool, required): Skip leads that already have conversations with other sender accounts.

  • excludeContactedFromSenderInOtherCampaign (bool, required): Skip leads the sender accounts have already contacted in other campaigns.

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

post//api/public/campaign/CreateCampaignFromTemplate

Request

  • Base URL: https://api
  • URL: https://api//api/public/campaign/CreateCampaignFromTemplate
  • Auth: none declared

Headers

X-API-KEYstring

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

Request body

campaignIdForTemplateinteger required
namestring required
linkedInUserListIdinteger required
excludeContactedFromOtherCampaignsboolean required
excludeHasOtherAccConversationsboolean required
excludeContactedFromSenderInOtherCampaignboolean required
linkedInAcccountIdsForCampaigninteger[] required
excludeListIdunknown

Response

OK

campaignIdinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.