Create a campaign

POST

/api/v1/campaigns

Request bodyrequired

namerequired

string

graphrequired

object

nodesrequired	object[]
edgesrequired	object[]

scheduleoptional

object

workingDaysoptional	integer[]
startTimeoptional	string
endTimeoptional	string

limitsoptional

object

minGapSecondsoptional	integer
maxGapSecondsoptional	integer
maxNewLeadsPerDayoptional	integer \| null

suppressionPolicyoptional

object

bypassSuppressionReasonsoptional	"manual" \| "unsubscribed" \| "not_interested" \| "existing_customer" \| "open_opportunity" \| "competitor" \| "employee" \| "invalid_recipient" \| "complained" \| "recently_contacted" \| "unresponsive"[]
cooldownDaysoptional	integer
unresponsiveAfterTouchesoptional	integer
autoSuppressKeywordsoptional	string[]

Response

201Created campaign.

campaign

object

string · uuid

ownerOrgId

string · uuid

name

string

status

"draft" | "active" | "paused" | "completed" | "archived"

graph

object

nodes	object[]
edges	object[]

schedule

object

workingDays	integer[]
startTime	string
endTime	string

limits

object

minGapSeconds	integer
maxGapSeconds	integer
maxNewLeadsPerDayoptional	integer \| null

suppressionPolicy

object

bypassSuppressionReasons	"manual" \| "unsubscribed" \| "not_interested" \| "existing_customer" \| "open_opportunity" \| "competitor" \| "employee" \| "invalid_recipient" \| "complained" \| "recently_contacted" \| "unresponsive"[]
cooldownDays	integer
unresponsiveAfterTouches	integer
autoSuppressKeywords	string[]

dryRun

boolean

startedAt

string · date-time | null

startedBy

string · uuid | null

pausedAt

string · date-time | null

pausedBy

string · uuid | null

completedAt

string · date-time | null

archivedAt

string · date-time | null

archivedBy

string · uuid | null

createdAt

string · date-time

createdBy

string · uuid | null

updatedAt

string · date-time

updatedBy

string · uuid | null

connectedAccounts

object[]

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

400: Bad request
401: Unauthorized: missing or invalid API key
403: Forbidden
404: Not found
422: Invalid request payload

Request bodyrequired

Response

Errors

Search docs