Email Design Theme Object


An email design theme is a reusable definition of an email's look and feel, such as its colors, fonts, and spacing. Site owners save email design themes in the Wix email editor and apply them to the emails they compose, such as Wix Email Marketing campaigns and automated emails.

Properties
bodyStruct

Styling definition of the email design theme, as a free-form JSON object. Its structure is defined by the Wix email editor. For example, palette holds the theme's colors, and classes maps named styles such as heading-text and primary-button to the properties the editor applies.

The Wix email editor doesn't render styling that doesn't follow its structure. When body doesn't define a style class, the editor uses its default styling for that class. When body doesn't include palette, the theme's color palette is empty.

This API doesn't validate the structure of body, so a theme that saves successfully may still not render as expected. Don't rely on a particular set of keys being present, and ignore keys you don't recognize. Don't store personal data in body.

Limited to 256 KB (262,144 bytes), measured on the JSON encoding without insignificant whitespace.


createdDatestringRead-onlyformat date-time

Date and time the email design theme was created.


extendedFieldsExtendedFields

Custom field data for the email design theme.

Extended fields must be configured in the app dashboard before they can be accessed with API calls. Don't store personal data in extended fields.

To update extended fields, call Update Extended Fields. Update Email Design Theme also applies any extendedFields specified in the request.


idstringRead-onlyformat GUID

Email design theme ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the email design theme is updated. To prevent conflicting changes, the current revision must be passed when updating the email design theme.

Ignored when creating an email design theme.


tagsTags

Tags assigned to the email design theme. Tags are owned by the Tags API (SDK | REST), which you can use to resolve these IDs into labels and to create tags.

Specifying tags in Update Email Design Theme replaces the existing tags instead of adding to them. To assign or unassign individual tags, call Bulk Update Email Design Theme Tags.


titlestringminLength 1maxLength 200

Email design theme title. Titles aren't unique, so a site can have multiple email design themes with the same title. To help site owners tell them apart, display additional context alongside the title, such as the date the email design theme was last updated.


updatedDatestringRead-onlyformat date-time

Date and time the email design theme was updated.

Did this help?