Campaigns

Campaign send status

Lightweight live send-state (running/paused/completed), schedule-window state, and headline metrics. Deep reporting lives under the analytics endpoints.

Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all.

get/v1/campaigns/{id}/status

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns/{id}/status
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60

Response

idstring uuid required
status'draft' | 'scheduled' | 'active' | 'paused' | 'stopped' | 'completed' | 'failed' required
isWithinScheduleboolean 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.

nextScheduleOpensAtstring date-time nullable

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.

Example response

{
  "id": "a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60",
  "status": "active",
  "isWithinSchedule": true,
  "metrics": {
    "leadsCount": 150,
    "sent": 120,
    "opens": 90,
    "clicks": 25,
    "replies": 12
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.