> ## Documentation Index > Fetch the complete documentation index at: https://developers.redo.com/llms.txt > Use this file to discover all available pages before exploring further. # Campaign > A one-off marketing send to a set of segments, on a single channel. **Required scopes:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read), [`campaigns_write`](/docs/api-reference/v3/reference/scopes#scope-campaigns_write) CampaignAnalytics!} required> Analytics for this campaign, grouped by what is being measured. CampaignMessagingAnalytics!} required> Email and SMS performance, read from the analytics warehouse: what was sent, how it was engaged with, and the orders and revenue attributed to it. **Requires:** [`campaigns_analytics_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_analytics_read) **Arguments** How many days after a message an order still counts toward it, 1-30. Date!} required> Last day to report on, inclusive, in the store's timezone. The range may span at most 400 days. Date!} required> First day to report on, inclusive, in the store's timezone. Must be on or before `endDate`, and the range may span at most 400 days. **Fields** [MessageAnalyticsPoint!]!} required> One entry per day with activity, oldest first. Quiet days are omitted rather than reported as zero. MessageAnalyticsTotals!} required> Totals across the whole range. A campaign with no activity reports zero counts and null rates. DateTime}> When the merchant canceled the campaign, if they did. MarketingChannel!} required> The channel this campaign sends on. DateTime!} required> When the campaign was created. [CampaignEmailVariant!]!} required> The email content this campaign sends, oldest arm first. A campaign that is not split-testing has exactly one entry; there is no separate `subject` on the campaign because a split test has more than one. The share of recipients this variant was sent to. A campaign with a single variant weights it 1. This variant's position within the campaign, starting at 0. Stable, so it names an arm of a split test across reports. EmailTemplate}> The content this variant sent. Null when the template has since been deleted. **Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read) The content canvas background, as set under Email styles in the email builder. DateTime!} required> When the template was created. The email background, as set under Email styles in the email builder. The id of this template. The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration. The default link color, as set under Email styles in the email builder. Null when the merchant left it unset. The merchant-facing name of the template. EmailTemplatePreview}> Render this template, to see what recipients get. Use a width of about 375 for a phone. **Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read) **Arguments** Render with this recent event's data instead of sample data: a 24-character hex event id. A well-formed id that can't be found falls back to sample data. Viewport width of the screenshot, 320-1200 pixels. The preview text shown after the subject in an inbox. Null when the merchant left it unset. [EmailTemplateSection!]!} required> The blocks that make up the email body, in order. Nested column children keep their own ids. A type this API version does not model field-by-field is returned as EmailTemplateUnknownSection. [JSON!]!} required> `sections` with every field selected, as JSON: one element per root block, in order, with `__typename` and nested column children. Empty or unreadable stored sections are \[]. Edits go through operations. The subject line **as authored**, before per-recipient substitution. A subject containing `{{ }}` placeholders is filled in per customer at send time, and some sends prepend a prefix, so this is not necessarily the subject any one customer saw. Empty when the template has no subject of its own. MarketingTrigger!} required> The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version. DateTime!} required> When the template was last edited. Templates stay editable after the campaigns that used them have finished, so compare this against a campaign's `finishedAt` to tell whether the content here is still what that campaign actually sent. CampaignErrorCode}> Why the campaign failed, when it did. [Segment!]!} required> The segments held out of this campaign. **Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read) JSON}> Dynamic segment condition tree. Null for static and persona segments. DateTime}> When the member counts were last recalculated. They are not live. DateTime!} required> When the segment was created. The merchant's description of who this segment is for. Members subscribed to email marketing as of `countsRefreshedAt`. The id of this segment. The segment's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration. Customers in the segment as of `countsRefreshedAt`. Null until it has first been counted. The merchant-facing name of the segment. Members subscribed to SMS marketing as of `countsRefreshedAt`. SegmentType!} required> How membership of this segment is determined. DateTime!} required> When the segment was last updated. DateTime}> When the campaign failed to send, if it did. CampaignFollowUpConfig}> Follow-up email configuration when one was enabled. Delay after the original send before the follow-up goes out. Whether a follow-up send is configured. CampaignFollowUpEngagementPeriod}> Engagement window, in days, used to pick recipients. Legacy Mongo ObjectId of the campaign this follow-up was created from. Subject line for the follow-up email. EmailAddress}> The from address recorded when the campaign sent. Null for drafts and for SMS campaigns. The mailbox address. The display name shown alongside the address. EmailSender}> The From mailbox chosen for this campaign. Null when the store default should be used, and for SMS. **Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read) DateTime!} required> When the address was added. The mailbox address. The id of this sender address. Pass it to `updateCampaign`. The display name shown alongside the address. The id of this campaign. The campaign's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration. The merchant-facing name of the campaign. EmailAddress}> The reply-to address recorded when the campaign sent. Null when none was set. The mailbox address. The display name shown alongside the address. EmailSender}> The Reply-To mailbox chosen for this campaign. Null when the store default should be used. **Requires:** [`campaigns_read`](/docs/api-reference/v3/reference/scopes#scope-campaigns_read) DateTime!} required> When the address was added. The mailbox address. The id of this sender address. Pass it to `updateCampaign`. The display name shown alongside the address. DateTime}> When the campaign is scheduled to start sending. Null for drafts, and for campaigns scheduled in each recipient's local time. IANA time zone the merchant picked when scheduling a single UTC instant. Null for drafts and local-time sends. IANA time zone used when a recipient has no time zone, for local-time sends. Null when `scheduledAt` is set. For campaigns scheduled in each recipient's local time, the wall-clock time they send at, as `YYYY-MM-DDTHH:mm:ss`. Null when `scheduledAt` is set. [Segment!]!} required> The segments this campaign was sent to. **Requires:** [`segments_read`](/docs/api-reference/v3/reference/scopes#scope-segments_read) JSON}> Dynamic segment condition tree. Null for static and persona segments. DateTime}> When the member counts were last recalculated. They are not live. DateTime!} required> When the segment was created. The merchant's description of who this segment is for. Members subscribed to email marketing as of `countsRefreshedAt`. The id of this segment. The segment's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration. Customers in the segment as of `countsRefreshedAt`. Null until it has first been counted. The merchant-facing name of the segment. Members subscribed to SMS marketing as of `countsRefreshedAt`. SegmentType!} required> How membership of this segment is determined. DateTime!} required> When the segment was last updated. DateTime}> When the campaign finished sending. Null until it has finished. [CampaignSmsVariant!]!} required> The SMS content this campaign sends, oldest arm first. Empty for email campaigns. The share of recipients this variant was sent to. A campaign with a single variant weights it 1. This variant's position within the campaign, starting at 0. SmsTemplate}> The content this variant sent. Null when the template has since been deleted. **Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read) Whether links in the body are shortened at send time. The SMS body **as authored**, before per-recipient substitution. DateTime!} required> When the template was created. The id of this template. [SmsTemplateImage!]!} required> Images sent with the message as MMS, in order. Dynamic product images and contact cards set in the editor are not listed. The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration. The merchant-facing name of the template. MarketingTrigger!} required> The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version. DateTime!} required> When the template was last edited. CampaignStatus!} required> Derived lifecycle status from schedule, send, failure, and cancellation timestamps. Tags the merchant applied to this campaign, in the order they applied them. Free-form and merchant-defined — Redo attaches no meaning to them, so they are the place a store's own categorisation (a promotion name, a season, a product line) is kept. Empty when the campaign is untagged. DateTime!} required> When the campaign was last updated. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.