UpdateCampaignInput

Input Object

analyticParams

Custom analytics parameters (e.g., UTM tags) to append to tracked links. Omit to keep existing values. Pass empty array to clear. Items missing name or value are ignored.

audienceFilters

Filters to include or exclude specific groups from the campaign. Only applicable when IncludeEntireAudience is false. Omit to keep existing values. Pass empty array to clear. Items missing groupId are ignored.

audienceId

The unique identifier of the audience to target with this campaign. This defines which personalization fields and contact targeting options are available.

contentCount

The number of content variations for multivariate testing.

customHeaders

Custom email headers to include with the campaign sends. Omit to keep existing values. Pass empty array to clear. Items missing name or value are ignored.

description

A brief description of the campaign's purpose or content. Maximum length: 255 characters.

enableAnalytics

When true, appends analytics tracking parameters to links in the campaign.

enableAutoRetry

Enables automatic retry of failed sends using the account's configured auto-retry rules (plan permitting).

fromCount

The number of sender (from) variations for multivariate testing. Must match the length of the Froms array when greater than 1.

froms

The sender identities for the campaign. For standard campaigns, provide exactly one entry. For multivariate testing with from variations, provide entries matching FromCount. Omit to keep existing values. Pass empty array to clear. Items missing email are ignored.

globalPreheaderInd

When true, uses a single preheader across all subject variations rather than individual preheaders per subject.

id

The unique identifier of the campaign to update.

includeEntireAudience

When true, the campaign targets all contacts in the audience. When false, use AudienceFilters to specify which groups to include or exclude.

isArchived

Archives the campaign, hiding it from active views. Can only be set to true when send status is NOT_SCHEDULED, STOPPED, COMPLETED, SYSTEM_STOPPED, or READY_TO_SEND.

isOperational

When true, marks the campaign as operational/transactional, bypassing unsubscribe preferences.

language

The language/locale for the campaign content. Must be a valid culture code (e.g., 'en-US', 'fr-FR'). See supported culture codes .

mvGoal

The metric used to determine the winning variation in multivariate tests (e.g., opens, clicks, revenue).

mvHypothesis

A description of what you expect to learn from the multivariate test.

mvTestPct

The percentage of total recipients (0-100) used for the multivariate test sample before sending the winner to the remainder.

mvWinSendUtc

The time of day (UTC) to send the winning variation to remaining recipients. Only the time portion is used; the date is ignored.

mvWinSendWait

The duration to wait after selecting a winner before sending to remaining recipients. Used with MvWinSendWaitType.

mvWinSendWaitType

The time unit (hours, days, etc.) or contact count for MvWinSendWait.

mvWinType

The method used to select the winning variation (e.g., automatic based on goal, manual selection).

mvWinWait

The duration to wait before determining the multivariate test winner. Used with MvWinWaitType.

mvWinWaitType

The time unit (hours, days, etc.) or contact count for MvWinWait.

name

The display name of the campaign. Maximum length: 100 characters.

purposeType

The primary purpose or intent of the campaign (e.g., Newsletter, Promotion, Notice, Reengagement).

replyEmail

The email address where recipient replies will be forwarded. Maximum length: 320 characters.

rssCheckType

The type of check to perform against the RSS feed to determine if a job should be sent. Only used for RSS campaigns.

rssSendFrequency

CRON expression defining when RSS campaign jobs should be triggered. Only used for RSS campaigns.

rssSendIfNoNewOrUpdatedItems

When true, sends the RSS campaign even if no new or updated items exist since the last check. Only used for RSS campaigns.

rssUrl

The URL of the RSS feed to pull content from. Only used for RSS campaigns.

segmentId

The unique identifier of a custom segment to further filter campaign recipients.

sendScheduleType

Determines how the campaign send is scheduled (e.g., immediate, scheduled, recurring).

sendTimeCount

The number of different send times for multivariate testing. When greater than 1, all other variation counts (subjects, froms, content) must be set to 1.

subjectCount

The number of subject line variations for multivariate testing. Must match the length of the Subjects array when greater than 1.

subjects

The subject lines and preheaders for the campaign. For standard campaigns, provide exactly one entry. For multivariate testing with subject variations, provide entries matching SubjectCount. Omit to keep existing values. Pass empty array to clear. Items missing subject are ignored.

tags

Tags for categorizing and organizing the campaign. Maximum of 50 tags, each up to 100 characters.

timeJumper

When enabled, sends the campaign at the scheduled time in each recipient's local timezone (e.g., 8 AM in their timezone rather than a single UTC time).

trackBrowser

When true, captures the browser type used when recipients interact with the campaign.

trackDomains

When true, tracks which email domains recipients are using. Defaults to true.

trackEngagement

Controls whether this campaign's events contribute to subscriber engagement scoring. When false, events are recorded but don't update engagement statistics.

trackHardware

When true, captures device/hardware information when recipients interact with the campaign.

trackLinkClicks

When true, tracks clicks on links within the campaign content.

trackLocation

When true, captures approximate geographic location of recipients when they interact with the campaign.

trackOpens

When true, tracks when recipients open the campaign email.

trackReplies

When true, tracks and logs email replies to this campaign.