object'campaign' required
slugstring nullable required
status'draft' | 'active' | 'paused' required
The campaign's lifecycle state.
workspaceIdstring uuid nullable required
Legacy home workspace; null for campaigns created from workspace-less chats.
tableIdstring uuid nullable required
Derived leads table (dominant enrolled-sequence table); null for a shell campaign.
outOfLeadsboolean required
haltedCountinteger required
How many of an active campaign's people a disconnected sender stopped rather than their finishing. Reported for every active campaign, so it can be above zero while the campaign is still sending to everyone else; combine it with outOfLeads to read the campaign's end state. outOfLeads alone cannot tell a campaign that completed from one that was cut short, since both have nothing pending: outOfLeads with haltedCount above zero means the campaign ended early, and reconnecting the sender resumes those people while adding leads will not reach them. Zero for draft and paused campaigns.
createdAtstring date-time required
updatedAtstring date-time required