Campaign

A campaign runs leads through a published sequence of email and task steps. It sends only when it has a published sequence and `state` is `active`.

Properties

idstring

Campaign ID (UUID)

namestring

Campaign name

descriptionstring

Campaign description

statestring

`active` sends on schedule; `paused` halts sending. New campaigns start paused.

"active""paused"

has_published_sequenceboolean

Whether a sequence has been published. A campaign with no published sequence never enrols leads.

is_archivedboolean

Whether the campaign has been archived

settingsobject

Sending settings: `sending_window_start` / `sending_window_end` (HH:MM), `timezone`, `remove_on_reply`, `create_task_on_reply`, `bounce_rate_limit`.

lead_schemaarray of

The campaign's lead fields. Returned by Get Campaign only.

CampaignLeadField

created_atstring <date-time>

updated_atstring <date-time>

Example

Campaign example

{
  "id": "string",
  "name": "Q3 Outbound",
  "description": "string",
  "state": "active",
  "has_published_sequence": false,
  "is_archived": false,
  "settings": {},
  "lead_schema": [
    {
      "name": "company",
      "type": "string",
      "required": false
    }
  ],
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}