Choose a version:

CustomerEmailAddress

object

Requires read_customers access scope.

Represents an email address.

Anchor to FieldsFields

Anchor to emailAddressemailAddress •String!non-null: The customer's default email address.
Anchor to marketingOptInLevelmarketingOptInLevel •CustomerMarketingOptInLevel: The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, received when the marketing consent was updated.
Anchor to marketingStatemarketingState •CustomerEmailAddressMarketingState!non-null: Whether the customer has subscribed to email marketing.
Anchor to marketingUnsubscribeUrlmarketingUnsubscribeUrl •URL!non-null: The URL to unsubscribe a member from all mailing lists.
Anchor to marketingUpdatedAtmarketingUpdatedAt •DateTime: The date and time at which the marketing consent was updated.

No date is provided if the email address never updated its marketing consent.
Anchor to openTrackingLevelopenTrackingLevel •CustomerEmailAddressOpenTrackingLevel!non-null: Whether the customer has opted in to having their opened emails tracked.
Anchor to openTrackingUrlopenTrackingUrl •URL!non-null: The URL that can be used to opt a customer in or out of email open tracking.
Anchor to sourceLocationsourceLocation •Location: The location where the customer consented to receive marketing material by email.
Anchor to validFormatvalidFormat •Boolean!non-null: Whether the email address is formatted correctly.

Returns true when the email is formatted correctly. This doesn't guarantee that the email address actually exists.

Was this section helpful?