Emailsubscription Object


Properties
idstringRead-onlyformat GUID

Email subscription ID.


emailstringformat EMAIL

Email address.


subscriptionStatusstring

Indicates the recipient's opt-in or opt-out status for marketing emails.

  • NOT_SET: No status specified. This is the default, initial value before any info about the email address is known.
  • PENDING: Subscription confirmation was requested, but recipient hasn't confirmed yet.
  • SUBSCRIBED: Recipient has opted in to marketing emails.
  • UNSUBSCRIBED: Recipient has opted out of marketing emails.

Defaults to NOT_SET.


deliverabilityStatusstring

Indicates last reported status of sent emails.

  • NOT_SET: No status specified. This is the default, initial value before any info about the email address is known.
  • VALID: Emails to this email address are being delivered successfully.
  • BOUNCED: The last email to the recipient bounced or was rejected.
  • SPAM_COMPLAINT: The recipient registered a spam complaint with their email provider.
  • INACTIVE: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.) This status might impact subsequent emails sent to this address.

Defaults to NOT_SET.


createdDatestringRead-onlyformat date-time

Date and time the email subscription was created.


updatedDatestringRead-onlyformat date-time

Date and time the email subscription was last updated.

Did this help?