Skip to main content
A campaign is a sequence of automated outreach steps targeting a set of prospects. Campaigns have a lifecycle represented by their status and can be archived when no longer needed.

​
Fields

​
id
string (uuid)
required
Unique identifier for the campaign.
​
objectType
string
required
Always campaign.
​
name
string
required
The name of the campaign.
​
status
string
required
The current status of the campaign. One of draft, active, paused, or completed.
​
isArchived
boolean
required
Whether the campaign is archived.
​
launchedAt
string (date-time)
Timestamp when the campaign was launched.
​
createdAt
string (date-time)
required
Timestamp when the campaign was created.
​
updatedAt
string (date-time)
required
Timestamp when the campaign was last updated.

​
Example

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "objectType": "campaign",
  "name": "Q1 Outbound",
  "status": "active",
  "isArchived": false,
  "launchedAt": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-10T08:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

​
Used in