# The campaign object Campaigns send an email to a prepared list of recipients. Use the campaign endpoints to prepare content, build the recipient list, and schedule delivery. ## Attributes - `id` (integer) — Identifier assigned by the API. - `sport_id` (integer) — ID of the sport. - `name` (string) — Campaign name, up to 255 characters. - `subject` (string) — Email subject, up to 255 characters. Defaults to an empty string on creation. - `track_opens` (boolean) — Whether to collect email open counts. - `template_id` (integer or null) — ID of a saved email template. Use this or supply campaign content. - `body_html` (string or null) — Campaign HTML. - `body_json` (map or JSON string) — Structured content with a blocks array. Blocks use an id and type. Supported types are heading, paragraph, image, spacer, and separator. - `recipient_config` (map or null) — Configuration recorded when building the recipient list. - `status` (string) — Current state: draft, ready, scheduled, sending, sent, or cancelled. - `scheduled_at` (integer or null) — Scheduled send time as Unix seconds. - `started_at` (integer or null) — Time sending started, in Unix seconds. - `finished_at` (integer or null) — Time sending finished, in Unix seconds. - `recipients` (integer) — Number of campaign recipients. - `open_count` (integer) — Number of recipients recorded as opening the email when tracking is enabled. - `open_rate` (number) — Percentage of recipients recorded as opening the email. ## Example Example with fictional data and selected fields. ```json { "id": 24, "sport_id": 3, "name": "November club news", "subject": "News from the club", "body_html": "
Registration for the winter program opens this week.
", "track_opens": false, "template_id": null, "recipient_config": null, "status": "draft", "scheduled_at": null, "recipients": 0, "open_count": 0, "open_rate": 0 } ```