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,
stopped,
completed,
failed
Example:

"active"

isWithinSchedule
boolean
required

Whether the campaign is currently inside its sending window.

Example:

true

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

When the next sending window opens; null when in-window or not active.