Create
Creates a campaign in DRAFT status.
After the campaign is fully configured, call StartCampaign (POST /api/public/campaign/StartCampaign?campaignId=) to activate it.
Important: a campaign cannot be activated without a sequence. 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
actionDelayrules, theSEND_LEAD_TO_*(Instantly / Smartlead / EmailBison) payload schemas, and the integration node errors - all of it applies identically here. Note thatpayloadis required forCONNECTION_REQUEST,MESSAGE,INMAIL,LIKE_POST,SEND_LEAD_TO_INSTANTLY,SEND_LEAD_TO_SMARTLEADandSEND_LEAD_TO_BISONnodes; omitting it is rejected withError in the <NODE_TYPE> node of the campaign sequence. The required payload was not provided.Note: every node that follows an action step (includingENDnodes) must haveactionDelayof at least 3 hours - useactionDelay: 3withactionDelayUnit: "HOUR"; an omitted or0delay is rejected withNode at: ... has invalid delay: 00:00:00. If this parameter is omitted, add it via UpdateSequence before starting.
Headers
API key header using this scheme. Example: “X-API-KEY: {API_KEY}”
