Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

Campaign name.

Minimum string length: 1
steps
(email · object | linkedin_message · object | linkedin_message_bundle · object | linkedin_voice_message · object | linkedin_inmail · object | linkedin_visit_profile · object | linkedin_like_last_post · object | whatsapp_message · object | condition · object | linkedin_connection · object | task · object | add_to_another_campaign · object | end · object)[]
required

Ordered campaign steps. Use branch arrays like onTrue, onFalse, onAccepted, and onNotAccepted for branching.

Minimum array length: 1
description
string | null

Optional campaign description.

identityId
integer | null
shouldAutomaticallySend
boolean
shouldSendTrackingPixel
boolean
excludeContactedLeads
boolean
allowedEmails
string[]

Allowed sender email addresses for this campaign.

Response

Campaign payload is valid against the public simplified schema

status
enum<string>
required
Available options:
success
message
string
required
data
object
required