ISubscribe

Interface

Properties

Property Type Notes
cadence Cadence

Frequency of the subscription

deliveryMethod DeliveryMethod

Delivery method for subscription, ie email or text

metadata ISubscribeMetadata

Metadata for the subscription

notificationSpecName SystemNotificationSpecNames

Notification spec name for the subscription

action Optional SubscriptionAction

Type of action representing user selections that further customize the subscription behavior

agoId Optional string

ArcGIS Online id for a user. Will always be extracted from the token unless service token is used.

catalog Optional ISubscribeCatalog

catalog for a subscription

deleted Optional boolean

Flag for deleted user

email Optional string

Email for the subscriber. Will always be extracted from the token unless service token is used.

entityId Optional string

The AGO id of the entity associated with the subscription

entityType Optional SubscriptionEntityType

The type of entity associated with the subscription entityId

firstName Optional string

First name for the subscriber. Will always be extracted from the token unless service token is used.

lastName Optional string

Last name for the subscriber. Will always be extracted from the token unless service token is used.

optedOut Optional boolean

Flag for unsubscribed user

username Optional string

Username for the subscriber. Will always be extracted from the token unless service token is used.


Interface defined in common/src/newsletters/api/orval/api/orval-newsletters.ts:114