Skip to main content
POST
Create campaign

Body

application/json
name
string
required

The campaign name.

description
string | null

A note about the campaign.

platform
enum<string>

The network. Defaults to x. Set it when you create the campaign; it cannot change later.

Available options:
x,
linkedin
audience
object[]

The lead lists it targets.

accountIds
string[]

The accounts that send for it.

sequence
object[]

The steps, in order: message, wait, connect (LinkedIn) or inmail (LinkedIn).

send
object

When and how fast it sends: perHour, dailyPerAccount, timezone, schedule.

exclusions
object

Who to leave out: activeCampaigns, previouslyTargeted, existingConversations, noProfilePhoto.

autoTranslate
boolean

Translate messages to each lead's language. LinkedIn only.

replyAgentId
string | null

The AI agent that replies to its leads. null when none.

Response

OK. Check status: errors the API handles itself also return 200.

status
boolean
required

true when the request succeeded.

data
object
required
error
null
required

Always null on success.