CreateCampaignInput

Input Object

audienceFilters

Sets target audience groups and/or segments. If including the entire audience, only excluded groups or segments are allowed.

audienceId

Defines which audience will be used to select merge tags and contacts from.

copyContentIndex

When copying from a multivariate campaign, specifies the zero-based index of the Content variation to use. Defaults to the first (0).

copyFromIndex

When copying from a multivariate campaign, specifies the zero-based index of the From variation to use. Defaults to the first (0).

copySubjectIndex

When copying from a multivariate campaign, specifies the zero-based index of the Subject variation to use. Defaults to the first (0).

description

Description of campaign. *Max length: 255

enableAutoRetry

Indicates if auto-retry rules should be enabled. This is for future use only.

fromEmail

Email of who the campaign is from. Max length: 320

fromName

Name to display who the campaign is from. Max length: 100

includeEntireAudience

If set, this will override target audience settings when copying from a previous campaign

isMultivariate

Indicates this is a multivariate campaign.

language

Language used to encode the content of the campaign. culture code .

name

Campaign name. Max length: 100

parentId

System use for RSS only

preheader

Preheader or preview to display next to or below the subject line before the email is opened. Max length: 100

previousCampaignId

Campaign that will be copied from to create the campaign. This supersedes the ReferenceTemplateId

purposeType

The purpose of the campaign.

referenceTemplateId

Template that will be used for the campaign

replyEmail

Email address used for replies. If this is specified, Tarvent cannot process or filter remote bounces, out-of-office emails, and other emails you may not want to receive. However, the recipient will see a more friendly reply-to email address. Max length: 320

subject

Subject line of the campaign. Max length: 100

tags

Tags to be associated with the campaign. Max length: 100 per tag

trackEngagement

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

type

Indicates the type of campaign and editor that will be used.