The campaign object

API referenceCampaigns

From the Campaigns API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

json

{
  "id": "b6a1e7b0-2f2b-4b7a-8e2a-1a2b3c4d5e6f",
  "projectId": "8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a",
  "name": "Q3 outbound - agencies",
  "status": "draft",
  "assignedToUserId": null,
  "targetReplies": null,
  "targetLeads": null,
  "dailyLimit": 30,
  "stopOnReply": true,
  "stopOnAutoReply": true,
  "trackOpens": false,
  "trackClicks": true,
  "plainTextOnly": false,
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingHourStart": 9,
  "sendingHourEnd": 17,
  "timezone": "UTC",
  "recipientWindowHourStart": 8,
  "recipientWindowHourEnd": 17,
  "minWaitMinutes": 10,
  "rampEnabled": false,
  "rampStartPerSender": 3,
  "rampMaxPerSender": 15,
  "rampStepPerDay": 1,
  "brief": null,
  "entryStepId": null,
  "createdAt": "2026-06-01T09:00:00.000Z",
  "updatedAt": "2026-06-01T09:00:00.000Z",
  "startedAt": null,
  "completedAt": null
}

status is one of draft, active, paused, completed, archived. The object is the stored campaign row, so it can carry further fields than shown (for example linkedinAi). trackOpens is false by default; rampEnabled can start as true on a new campaign when your mailboxes are young.

Was this page helpful?

The campaign object

More from Campaigns