Skip to main content
POST
Activate Outreach Sequence

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

sequence_id
string
required

Query Parameters

send_immediately
boolean
default:false

Recurring sequences only: fire an initial wave now, then continue on schedule.

Response

Successful Response

id
string
required
name
string | null
required
description
string | null
required
status
enum<string> | null
required
Available options:
DRAFT,
ACTIVE,
PAUSED
cohortId
string | null
required
cooldownDays
integer | null
required
isMarketing
boolean | null
required
createdById
string | null
required
steps
OutreachStepDetail · object[]
required
createdDate
string<date-time>
required
cohortName
string | null
enrollmentStats
EnrollmentStats · object | null
updatedDate
string<date-time> | null
rrule
string | null
recurrenceStartDate
string<date-time> | null
recurrenceEndDate
string<date-time> | null
recurrenceTimezone
string | null
lastOccurrenceFiredAt
string<date-time> | null
nextSendAt
string<date-time> | null
cooldownWarning
string | null