Skip to main content
GET
Campaign send status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Response

id
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

status
enum<string>
required
Available options:
draft,
scheduled,
active,
paused,
completed,
failed
Example:

"active"

isWithinSchedule
boolean
required

Whether now is inside the sending window, for any status: within the campaign dates (not before startDate, not after the end of the endDate day in the campaign timezone) and inside the schedule (simple or advanced). A draft or paused campaign still does not send.

Example:

true

metrics
object
required
nextScheduleOpensAt
string<date-time> | null

When the campaign can next send (for any status): the next schedule window, or startDate itself when it falls inside a window. null when inside a window now, or when no window opens before the end of the endDate day.