The Campaign Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the Campaign |
name | string | Display name of the Campaign |
status | string | Current status of the Campaign. See Campaign Statuses below |
type | string | Campaign type. Possible values: anniversary, birthday, schedule, marketing, oneOffs, newHire. The API only allows creating oneOffs - other types are created via the Snappy Dashboard. |
source | string | Indicates how the Campaign was created (e.g. dashboard, dashboard_ai, api_native, api_zapier, api_make, api_salesforce, api_ftp) |
accountId | string | The ID of the Account this Campaign belongs to |
companyId | string | The ID of the Company this Campaign belongs to |
account | object | Embedded Account summary containing id and name |
customization | object | Gift Customization configuration including giftProperties, notificationPolicy, and recipientExperience. See Core Concepts & Data Models → Gift Customization |
createdAt | string | ISO 8601 timestamp of when the Campaign was created |
updatedAt | string | ISO 8601 timestamp of the last update |
Campaign Statuses
| Status | Description |
|---|---|
draft | The Campaign is being configured and is not yet ready to send gifts |
pending | The Campaign is awaiting activation (typically a Dashboard approval step) |
scheduled | The Campaign is scheduled to activate at a future date |
active | The Campaign is live and gifts can be created under it |
live | Equivalent to active for some Campaign types (Dashboard-driven) |
paused | The Campaign has been temporarily paused. No new gifts can be created |
sent | All gifts in the Campaign have been sent (terminal state for one-off sends) |
archived | The Campaign has been archived. No new gifts can be created |