Email promotions reference

This page describes the types used to annotate promotional email and their associated properties. These types and properties are included in a promotional email's header as JSON-LD.

To learn more, review the Email Markup Getting Started guide.

Organization

The Organization type lets you specify a logo to include in the promotion.

Name	Type	Description
`logo`	ImageObject or URL	The logo that displays as an icon for the sender. Recommended to use an HTTPS URL. See best practices for Logo URL.

DiscountOffer

The DiscountOffer type lets you create deal annotations, which promote the details of an offer such as the discount code or expiration date.

Name	Type	Description
`description`	Text	Optional. A short text that displays next to the deal badge icon, such as `Free shipping` or `20% off`. See best practices for the deal badge.
`discountCode`	Text	Optional. The discount or promotion code of the offer, such as `20PROMO`. See best practices for discount codes.
`availabilityStarts`	DateTime	Optional. The date and time when the offer begins in ISO 8601 format, such as `2023-09-25T18:44:37-07:00`.
`availabilityEnds`	DateTime	Optional. The end date and time of the promotion in ISO 8601 format, such as `2023-10-25T18:44:37-07:00`. See best practices for Expiration Date.

PromotionCard

The PromotionCard type lets you include a visual preview of your promotion.

Name	Type	Description
`image`	ImageObject or URL	Required. The image preview of the email in PNG or JPEG format. The supported aspect ratios are 4:5, 1:1, and 1.91:1. Images are center-cropped automatically. See best practices for images. For product carousels, each `PromotionCard` must have a unique image and use the same aspect ratio.
`url`	URL	Required. The URL for the promotion. When users click on the email's `image`, they are directed to this URL.
`headline`	Text	Optional. A 1 to 2-line description of the promotion that is displayed under the `image`.
`price`	Text	Optional. The price of the promotion. If you set a `discountValue`, the `price` displays as the original price of the promotion before the discount is applied.
`priceCurrency`	Text	Optional. The currency of the price in 3-letter ISO 4217 format, such as `USD`. Determines the currency symbol displayed with the price.
`discountValue`	Text	Optional. The amount subtracted from the `price` to display an adjusted price. The adjusted price is displayed next to the original price. For example, if the `discountValue` is set to `25`, the `price` is set to `100`, and the `priceCurrency` is `USD`, the adjusted price is displayed as `$75`.
`position`	Text	Optional. The position of the card in the carousel.