Skip to main content
Boolean
If true, disables the follow-up email.
Boolean
If true, reverts From to the store default.
Boolean
If true, reverts Reply-To to the store default.
Boolean
If true, removes the campaign’s schedule. Cannot be combined with other schedule fields.
String
Replace the preview text on every email variant.
String
Replace the subject line on every email variant.
Replace the email arms. One arm is a single send; two or more is an A/B split. Each templateId is an existing template.
[ID!]
Replace the excluded audience with these segments.
Set follow-up email settings. Email campaigns only. Cannot be combined with clearFollowUp.
ID
From mailbox from emailAddresses. Email campaigns only. Cannot be combined with clearFromAddress.
String
The merchant-facing name of the campaign.
ID
Reply-To mailbox from emailAddresses. Email campaigns only. Cannot be combined with clearReplyToAddress.
When to start sending, as one UTC instant. Clears a local-time schedule. Use clearSchedule to unschedule.
String
IANA time zone for displaying scheduledAt. Requires scheduledAt. Omit to leave the current display zone unchanged.
String
IANA time zone used when a recipient has none. Must be paired with scheduledLocalTime.
String
Send at this wall-clock time in each recipient’s time zone, as YYYY-MM-DDTHH:mm:ss. Must be paired with scheduledLocalFallbackTimeZone. Clears scheduledAt.
[ID!]
Replace the included audience with these segments.
String
Replace the body on every SMS variant.
Replace the SMS arms. One arm is a single send; two or more is an A/B split. Each templateId is an existing template.
[String!]
Replace campaign tags with these names, in order. Names must already exist. Pass an empty list to clear.