Class EmailUpdateRequest

Properties of a marketing email you can update via the API.

Constructors

constructor

Properties

_from? activeDomain? archived? businessUnitId? campaign? content? jitterSendTime? language? name? publishDate? rssData? sendOnPublish? state? subcategory? subject? subscriptionDetails? testing? to? webversion? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optional_from

_from?: PublicEmailFromDetails

OptionalactiveDomain

activeDomain?: string

The active domain of the email.

Optionalarchived

archived?: boolean

Determines if the email is archived or not.

OptionalbusinessUnitId

businessUnitId?: number

Optionalcampaign

campaign?: string

The ID of the campaign this email is associated to.

Optionalcontent

content?: PublicEmailContent

OptionaljitterSendTime

jitterSendTime?: boolean

Optionallanguage

language?: EmailUpdateRequestLanguageEnum

Optionalname

name?: string

The name of the email, as displayed on the email dashboard.

OptionalpublishDate

publishDate?: Date

The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.

OptionalrssData

rssData?: PublicRssEmailDetails

OptionalsendOnPublish

sendOnPublish?: boolean

Determines whether the email will be sent immediately on publish.

Optionalstate

state?: EmailUpdateRequestStateEnum

The email state.

Optionalsubcategory

subcategory?: EmailUpdateRequestSubcategoryEnum

The email subcategory.

Optionalsubject

subject?: string

The subject of the email.

OptionalsubscriptionDetails

subscriptionDetails?: PublicEmailSubscriptionDetails

Optionaltesting

testing?: PublicEmailTestingDetails

Optionalto

to?: PublicEmailToDetails

Optionalwebversion

webversion?: PublicWebversionDetails

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods