Class PublicUpdateSubscriptionStatusRequest

A request to change the status of a contact's subscription.

Hierarchy

  • PublicUpdateSubscriptionStatusRequest

Constructors

constructor

Properties

emailAddress legalBasis? legalBasisExplanation? subscriptionId attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

emailAddress

emailAddress: string

Contact's email address.

Optional legalBasis

legalBasis?: PublicUpdateSubscriptionStatusRequestLegalBasisEnum

Legal basis for updating the contact's status (required for GDPR enabled portals).

Optional legalBasisExplanation

legalBasisExplanation?: string

A more detailed explanation to go with the legal basis (required for GDPR enabled portals).

subscriptionId

subscriptionId: string

ID of the subscription being updated for the contact.

Static Readonly attributeTypeMap

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

Type declaration

  • baseName: string
  • format: string
  • name: string
  • type: string

Static Readonly discriminator

discriminator: undefined | string = undefined

Methods

Static getAttributeTypeMap

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc