Skip to content

Rule.io SDK


Rule.io SDK / client/src / CampaignStatus

Interface: CampaignStatus

Defined in: client/src/resources/campaigns/campaigns.types.ts:34

Status/type descriptor object returned by the API for campaign status, messageType, and sendoutType fields.

The API encodes these fields as objects rather than bare enums so consumers get both a machine-readable code and a human-readable label.

Properties

description

description: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:40

Human-readable description.


key

key: string

Defined in: client/src/resources/campaigns/campaigns.types.ts:38

Machine-readable key (e.g. 'draft', 'scheduled', 'email').


value

value: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:36

Numeric code (e.g. 1 for draft, 4 for scheduled).