SubscriptionBundle

The Subscription API requests reference an object of type SubscriptionBundle. The configuration of the bundle will vary depending on the provided inputs. The following properties define this object

SubscriptionBundle Properties

• subscriptionId : String, Subscription Id.
• subscriber : String, Either a user id, contact id, lead id, or an email address.
• subscriberType : String, Describes subscriber. Possible type values:
  • user - Subscriber value will be a user id.
  • contact - Subscriber value will be a contact id.
  • lead - Subscriber value will be a lead id.
  • email - Subscriber value will be an email address.
• tagPath : String, Taxonomy tag path.
• schedule : ScheduleBundle, The schedule this subscription belongs to. A null value means the subscription is unscheduled.
• suspended : Boolean, Whether the scheduled subscription has been paused.
• verified : Boolean, Whether a contact, lead, or email address has been verified.