Check

Learn more about how to use the Check endpoints.

Check endpoints are part of the Content Services API. The Content Services API is available on Beefree SDK plans that are Essentials or above.

Overview

The Check group consists of three endpoints that scan a template's JSON or a row's JSON, to identify and report critical design elements that are missing. With these endpoints, you can bring design QA functionality into your application. They automatically check a design for common mistakes (including missing links, missing alt text, overly large images, or HTML file sizes that might cause your users' emails to get clipped in Gmail). This is possible through a POST request where you define the language, types of checks to perform, and the template or row JSON to check. The response will report any instances within the JSON where an item is missing, a limit is exceeded, and so on. It’ll also include the location (called target in the response body) of the item that needs attention within the JSON. For example, the uuid of an image module that is missing alt text.

When coupled with Frontend Commands, these endpoints act as a core pillar of an interactive feedback experience for your end users. Frontend Commands work by displaying visual cues within the user interface. These cues navigate end users to the part of the design and builder that requires their attention. From there, they can easily apply the changes, perform an additional check if they’d like, and export their designs.

Overall, the Check endpoints identify critical design elements, while Frontend Commands help your end users navigate to the elements that need fixing. Together, they create a tool kit that helps your end users create error-free designs, and support them in ensuring their content is complete and ready for their audiences to consume and enjoy.

For a comprehensive list of all the available checks, reference the Available Checks section of this page.

Available Collection Values for Check Endpoints

The following table lists the collection values available in this category of endpoints, and their corresponding collection options.

Prior to referencing the table, the following example shows how you can replace the {collection} placeholder based on the type of content you'd like to export.

How to Replace the {collection} Placeholder

The following example URL has a {collection} placeholder. This placeholder needs to be filled in with a Collection Option prior to making an API call.

https://api.getbee.io/v1/{collection}/check

As an example, if you'd like to check an email's HTML using this endpoint, replace {collection} with message.

The final URL to make the API call will be:

https://api.getbee.io/v1/message/check

The following table provides a comprehensive reference of all available options based on what you'd like to check.

Resource	Collection Options
/check	/message /page /row

How the Endpoints Work

The Check endpoints accept three parameters in the request body: languages, checks, and template or row. Reference the descriptions for each parameter below:

• languages: Define the language of the template.

• checks: Define the checks you want to perform on the template or row JSON. Do this by adding the category, the check, and the details for the check if applicable.

• template or row: Include the JSON for either an email template, a page template, or a row. This is the JSON that will be checked in ways defined in the checks section of the POST request.

IMPORTANT: This section includes a list of checks you can perform for the following designs:

• Email designs

• Page designs

• Rows within designs

The Check Endpoints section provides both an interactive testing environment for testing the checks and endpoints, and example request bodies you can use to get started with each of the three Check endpoints.

Authentication

To use these endpoints, authenticate by creating a Content Services API key in the Beefree SDK Developer Console. For steps on how to obtain a Content Services API key, visit the Content Services API Authentication page.

Available Checks

Reference the available checks you can perform using the Check endpoints in this section. You can perform checks on:

• Email template JSON: Use the v1/message/check endpoint to perform a check on email template JSON.

• Page template JSON: Use the v1/page/check endpoint to perform a check on page template JSON.

• Row JSON within a template: Use the v1/row/check endpoint to perform a check on row JSON within a template.

This section covers the available checks you can perform using these endpoints. Each check listed in this section will include which endpoints it applies to, how it looks in an example API request, and how it looks in an example response. It also explains each field and includes its corresponding data type and description.

Comprehensively, across all endpoints, the available checks are listed in the Available Checks by Endpoint section.

Available Checks by Endpoint

This section lists the each of the available check options by endpoint. The endpoints are /message/check, /page/check, and /row/check.

Common Checks Across All Endpoints

The following checks apply to email (/message/check), page (/page/check), and row (/row/check) endpoints:

Check Name	Key	Description
Missing alt text	missingAltText	Checks for images missing the alt attribute.
Missing link on copy	missingCopyLink	Ensures CTAs and copy elements have valid links.
Missing link on images	missingImageLink	Ensures images marked as clickable have links.
Image overage weight	overageImageWeight	Flags images that exceed size thresholds (500 KB for email and row, 700 KB for page).
Insufficient color contrast	insufficientColorContrast	Detects widgets failing WCAG 2.0 AA contrast ratios.
Unreachable web link	unreachableWebLink	Highlights broken or unreachable URLs.

/message/check (Email)

The following code snippet displays an example of how checks can be added to the body of the POST request. Test the endpoint in the Email section.

{
  "checks": [
    { "category": "missingAltText" },
    { "category": "missingImageLink" },
    { "category": "missingCopyLink" },
    { "category": "overageImageWeight", "limit": 500 },
    { "category": "missingDetailsEmail" },
    { "category": "overageHtmlWeight", "limit": 80, "beautified": true },
    { "category": "missingHeadings" },
    { "category": "overageHeadings" },
    { "category": "missingMainLanguage" },
    { "category": "unreachableWebLink", "allowed_hosts": ["example.com", "other-example.com"] },
    { "category": "insufficientColorContrast" }
  ]
}

Email-specific checks:

Check Name	Key	Description
Missing email details	missingDetailsEmail	Ensures required metadata (subject, preheader, footer info) is present.
HTML overage size	overageHtmlWeight	Flags overly large HTML payloads (limit 80 KB, beautified).
Missing headings	missingHeadings	Ensures headings exist for accessibility/navigation.
Overage headings	overageHeadings	Ensures exactly one <h1> exists (not missing or duplicated).
Missing main language	missingMainLanguage	Verifies that a language is set in template metadata.

/page/check (Page)

The following code snippet displays an example of how checks can be added to the body of the POST request. Test the endpoint in the Page section.

{
  "checks": [
    { "category": "missingAltText" },
    { "category": "missingImageLink" },
    { "category": "missingCopyLink" },
    { "category": "overageImageWeight", "limit": 700 },
    { "category": "missingDetailsPage" },
    { "category": "missingHeadings" },
    { "category": "overageHeadings" },
    { "category": "missingMainLanguage" },
    { "category": "unreachableWebLink", "allowed_hosts": ["example.com", "other-example.com"] },
    { "category": "insufficientColorContrast" }
  ]
}

Page-specific checks:

Check Name	Key	Description
Missing page details	missingDetailsPage	Ensures required metadata (title, description) is present.
Missing headings	missingHeadings	Ensures headings exist for accessibility/navigation.
Overage headings	overageHeadings	Ensures exactly one <h1> exists (not missing or duplicated).
Missing main language	missingMainLanguage	Verifies that a language is set in template metadata.

/row/check (Row)

The following code snippet displays an example of how checks can be added to the body of the POST request. Test the endpoint in the Row section.

{
  "checks": [
    { "category": "missingAltText" },
    { "category": "missingImageLink" },
    { "category": "missingCopyLink" },
    { "category": "overageImageWeight", "limit": 500 },
    { "category": "unreachableWebLink", "allowed_hosts": ["example.com", "other-example.com"] },
    { "category": "insufficientColorContrast" }
  ]
}

Row-specific checks: All supported checks are listed in the Common Checks Across All Endpoints section.

Missing Alt Text

This section covers the Missing Alt Text check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

Check details	Corresponding options
Type	Warning
Available for	Email and page messages, email and page templates, rows
Applicable widgets	Image, gif, sticker, icon, social

Perform this check by adding {"category":"missingAltText"} to your API call's request body.

Example response for a check that passed

The following JSON response shows an example of a missing alt text check that passed. This means that within the email, page, or row JSON, an instance of missing alt text was not identified, and the end user can confidently export their design knowing alt text is where it should be.

{
      "type": "missingAltText",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": []
}

Example response for a check that returned a warning

The following JSON response shows an example of a missing alt text check that resulted in a warning. This means that within the email, page, or row JSON, an instance of missing alt text was identified, and the end user should resolve the missing alt text in the corresponding target prior to exporting their design.

                {
                    "type": "missingAltText",
                    "targetsCount": 5,
                    "checkStatus": "warning",
                    "targets": [
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "f7ba2e08-c88f-4eda-9fc9-ab482a2dcfd0",
                            "widgetLabel": "https://media0.giphy.com/media/wIePCLOwUQ4RW/giphy.gif?cid=20eb4e9dky638ndajzn0mwpk6hqv3oi8ov705jq2nd4c7rll&ep=v1_gifs_trending&rid=giphy.gif&ct=g",
                            "widgetType": "gif",
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "9c38bcc0-71a0-4baa-9b61-43b3c30a620d",
                            "widgetLabel": "laptop-workspace-flat-design-3214756.jpg",
                            "widgetType": "image"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "c07bcd67-fb72-4218-85d7-1c5e97d5c79c",
                            "widgetLabel": "https://media2.giphy.com/media/in35qBAr9VKLtpPDe0/giphy.gif?cid=20eb4e9drwe6c1smz42ak0w4qims5tolgkij9rrut8vghj1s&ep=v1_stickers_search&rid=giphy.gif&ct=s",
                            "widgetType": "sticker"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
                            "widgetLabel": "custom-icon-placeholder.png",
                            "widgetType": "icon"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "27386d37-df5b-4f5a-b3df-f3e8a2c9d640",
                            "widgetLabel": "facebook",
                            "widgetType": "social"
                        }
                    ]
                }

The following table lists and defines all the fields related to the missingAltText check.

Field	Data type	Description
type	string	Check type, equal to missingAltText
targetsCount	integer	The number of widgets missing alt text
checkStatus	string	The status of this check: passed or warning
targets	array	The list of widgets missing alt text
locked	boolean	If the widget missing alt text is in a locked row
synced	boolean	If the widget missing alt text is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	Label of the widget missing alt text: filename for icon, url for image, gif and sticker and name for social
widgetType	string	Type of the widget missing alt text: image, gif, sticker, icon, social

Missing Link on Copy

This section covers the Missing Link on Copy check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

Check details	Corresponding options
Type	Warning
Available for	Email and page messages, email and page templates, rows
Applicable widgets	Button, social, menu

Perform this check by adding {"category":"missingCopyLink"} to your API call's request body.

Example response for a check that passed

The following JSON response shows an example of a missing copy link check that passed. This means that within the email, page, or row JSON, an instance of a missing copy link was not identified, and the end user can confidently export their design knowing copy links are where they should be.

{
      "type": "missingCopyLink",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": []
}

Example response for a check that returned a warning

The following JSON response shows an example of a missing copy link check that resulted in a warning. This means that within the email, page, or row JSON, an instance of a missing copy link was identified, and the end user should resolve the missing copy link in the corresponding target prior to exporting their design.

                {
                    "type": "missingCopyLink",
                    "targetsCount": 3,
                    "checkStatus": "warning",
                    "targets": [
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "9c38bcc0-71a0-4baa-9b61-43b3c30a620d",
                            "widgetLabel": "Button name 1",
                            "widgetType": "button"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "c07bcd67-fb72-4218-85d7-1c5e97d5c79c",
                            "widgetLabel": "Social name,
                            "widgetType": "social"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
                            "widgetLabel": "Menu name",
                            "widgetType": "menu"
                        }
                    ]
                }

The following table lists and defines all the fields related to the missingCopyLink check.

Field	Data type	Description
type	string	Check type, equal to missingCopyLink
targetsCount	integer	The number of widgets missing a link
checkStatus	string	The status of this check: passed or warning
targets	array	The list of widgets miss link
locked	boolean	If the widget missing link is in a locked row
synced	boolean	If the widget missing link is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	Label of the widget missing link
widgetType	string	Type of the widget missing alt text: button, menu, social

Missing Link on Images

This section covers the Missing Link on Images check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

Check details	Corresponding options
Type	Suggestion
Available for	Email and page messages, email and page templates, rows
Applicable widgets	Image, gif, sticker, icon

Perform this check by adding {"category":"missingImageLink"} to your API call's request body.

Example response for a check that passed

The following JSON response shows an example of a missing image link check that passed. This means that within the email, page, or row JSON, an instance of a missing image link was not identified, and the end user can confidently export their design knowing image links are where they should be.

{
      "type": "missingImageLink",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": []
}

Example response for a check that returned a warning

The following JSON response shows an example of a missing image link check that resulted in a warning. This means that within the email, page, or row JSON, an instance of a missing image link was identified, and the end user should resolve the missing image link in the corresponding target prior to exporting their design.

                {
                    "type": "missingImageLink",
                    "targetsCount": 4,
                    "checkStatus": "suggestion",
                    "targets": [
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "f7ba2e08-c88f-4eda-9fc9-ab482a2dcfd0",
                            "widgetLabel": "https://media0.giphy.com/media/wIePCLOwUQ4RW/giphy.gif?cid=20eb4e9dky638ndajzn0mwpk6hqv3oi8ov705jq2nd4c7rll&ep=v1_gifs_trending&rid=giphy.gif&ct=g",
                            "widgetType": "gif",
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "9c38bcc0-71a0-4baa-9b61-43b3c30a620d",
                            "widgetLabel": "laptop-workspace-flat-design-3214756.jpg",
                            "widgetType": "image"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "c07bcd67-fb72-4218-85d7-1c5e97d5c79c",
                            "widgetLabel": "https://media2.giphy.com/media/in35qBAr9VKLtpPDe0/giphy.gif?cid=20eb4e9drwe6c1smz42ak0w4qims5tolgkij9rrut8vghj1s&ep=v1_stickers_search&rid=giphy.gif&ct=s",
                            "widgetType": "sticker"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
                            "widgetLabel": "custom-icon-placeholder.png",
                            "widgetType": "icon"
                        }
                    ]
                }

The following table lists and defines all the fields related to the missingImageLink check.

Field	Data type	Description
type	string	Check type, equal to missingImageLink
targetsCount	integer	The number of widgets miss link
checkStatus	string	The status of this check: passed or suggestion
targets	array	The list of widgets miss link
locked	boolean	If the widget missing link is in a locked row
synced	boolean	If the widget missing link is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	Label of the widget missing link: filename for icon, url for image, gif and sticker
widgetType	string	Type of the widget missing alt text: image, gif, sticker, icon

Image Overage Weight

This section covers the Image Overage Weight check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

In the example detailed in this section, the weight limit is set to 500KB for emails and rows, and 700KB for pages. The "Content-Length" header in the response of HEAD requests from image, gif, sticker, icon, and social URLs is used to determine if the content size exceeds the specified limits. If the header is missing or the URL cannot be evaluated within 20 seconds, it is considered an error, and the URL is logged for review.

Check details	Corresponding options
Type	Suggestion
Available for	Email and page messages, email and page templates, rows
Applicable widgets	Image, gif, sticker, icon, social

Perform this check by adding {"category":"overageImageWeight", "limit": 500} to your API call's request body.

Field	Data type	Description
limit	int	Other such limit the image weight is considered overage in KB

Example response for a check that passed

The following JSON response shows an example of an image weight overage check that passed. This means that within the email, page, or row JSON, an instance of a limit overage was not identified, and the end user can confidently export their design.

{
      "type": "overageImageWeight",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": [],
       "limit": 500,
       "evaluated": 13,
       "errored": 3
}

Example response for a check that returned a warning

The following JSON response shows an example of an image weight overage check that resulted in a warning. This means that within the email, page, or row JSON, an instance of an image weight overages was identified, and the end user should resolve the overage prior to exporting their design.

                {
                    "type": "overageImageWeight",
                    "targetsCount": 5,
                    "checkStatus": "warning",
                    "limit": 500,
                    "evaluated": 13,
                    "errored": 0,
                    "targets": [
                        {
                            "locked": false,
                            "synced": false,
                            "weight": 51.32,
                            "uuid": "f7ba2e08-c88f-4eda-9fc9-ab482a2dcfd0",
                            "widgetLabel": "https://media0.giphy.com/media/wIePCLOwUQ4RW/giphy.gif?cid=20eb4e9dky638ndajzn0mwpk6hqv3oi8ov705jq2nd4c7rll&ep=v1_gifs_trending&rid=giphy.gif&ct=g",
                            "widgetType": "gif",
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "weight": 51.32,
                            "uuid": "9c38bcc0-71a0-4baa-9b61-43b3c30a620d",
                            "widgetLabel": "laptop-workspace-flat-design-3214756.jpg",
                            "widgetType": "image"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "weight": 51.32,
                            "uuid": "c07bcd67-fb72-4218-85d7-1c5e97d5c79c",
                            "widgetLabel": "https://media2.giphy.com/media/in35qBAr9VKLtpPDe0/giphy.gif?cid=20eb4e9drwe6c1smz42ak0w4qims5tolgkij9rrut8vghj1s&ep=v1_stickers_search&rid=giphy.gif&ct=s",
                            "widgetType": "sticker"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "weight": 51.32,
                            "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
                            "widgetLabel": "custom-icon-placeholder.png",
                            "widgetType": "icon"
                        },
                        {
                            "locked": false,
                            "synced": false,
                            "weight": 51.32,
                            "uuid": "27386d37-df5b-4f5a-b3df-f3e8a2c9d640",
                            "widgetLabel": "facebook",
                            "widgetType": "social"
                        }
                    ]
                }

The following table lists and defines all the fields related to the overageImageWeight check.

Field	Data type	Description
type	string	Check type, equal to overageImageWeight
targetsCount	integer	The number of widgets miss alt text
checkStatus	string	The status of this check: passed or warning
limit	integer	The limit given in the request
evaluated	integer	The number of evaluated images
errored	integer	The number of images impossible to get the content-length in head requests
targets	array	The list of widgets miss alt text
locked	boolean	if the widget missing alt text is in a locked row
synced	boolean	If the widget missing alt text is in a synced row
weight	float	The weight of the image in KB
uuid	string	uuid of the row containing this widget
widgetLabel	string	Label of the widget missing alt text
widgetType	string	Type of the widget missing alt text: image, gif, sticker, icon, social

Missing Email Details

This section covers the Missing Email Details check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

Check details	Corresponding options
Type	Suggestion
Available for	Email messages
Use general features in JSON	Head

Perform this check by adding {"category": "missingDetailsEmail"} to your API call's request body.

Example response for a check that passed

The following JSON response shows an example of a missing email details check that passed. This means that within the email, an instance of missing email details was not identified, and the end user can confidently export their design.

{
      "type": "missingDetailsEmail",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": [],
}

Example response for a check that returned a warning

The following JSON response shows an example of a missing email details check that resulted in a warning. This means that within the email, an instance of a missing email details was identified, and the end user should resolve the missing email details prior to exporting their design.

{
        "type": "missingDetailsEmail",
        "targetsCount": 2,
        "checkStatus": "suggestion",
        "targets": [{"detailType": "subject"}, {"detailType": "preheader"}],
}                            

The following table lists and defines all the fields related to the missingDetailsEmail check.

Field	Data type	Description
type	string	Check type, equal to missingDetailsEmail
targetsCount	integer	The number of missing email details
checkStatus	string	The status of this check: passed or suggestion
targets	array	The list of missing details
detailType	string	Type of the widget missing alt text: subject, preheader

Missing Page Details

This section covers the Missing Page Details check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

Check details	Corresponding options
Type	Suggestion
Available for	Page messages
Use general features in JSON	Head

Perform this check by adding {"category": "missingDetailsPage"} to your API call's request body.

Example response for a check that passed

The following JSON response shows an example of a missing page details check that passed. This means that within the page, an instance of missing page details was not identified, and the end user can confidently export their design.

{
      "type": "missingDetailsPage",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": [],
}

Example response for a check that returned a warning

The following JSON response shows an example of a missing page details check that resulted in a warning. This means that within the page, an instance of a missing page details was identified, and the end user should resolve the missing details prior to exporting their design.

{
        "type": "missingDetailsPage",
        "targetsCount": 2,
        "checkStatus": "suggestion",
        "targets": [{"detailType": "title"}, {"detailType": "description"}],
}

The following table lists and defines all the fields related to the missingDetailsPage check.

Field	Data type	Description
type	string	Check type, equal to missingDetailsPage
targetsCount	integer	The number of missing page details
checkStatus	string	The status of this check: passed or suggestion
targets	array	The list of missing details
detailType	string	Type of the widget missing text: title, description

HTML Overage Size

This section covers the HTML Overage Weight check, detailing the process of adding the check to the POST API call, and how it appears in example responses. It includes examples of both a successful check and one that returns a warning.

In the example detailed in this section, the weight limit is set to 80KB for emails and rows, and 700KB for pages. The given JSON HTML is translated and the weight is checked against the specified limit, with the "beautified" boolean determining whether the check applies to the beautified HTML or not. If the weight exceeds the limit, it is considered an error and should be flagged for review.

Check details	Corresponding options
Type	Warning
Available for	Email messages
Use general features in JSON	displayConditions

Perform this check by adding {"category":"overageHtmlWeight", "limit": 20, "beautified": true} to your API call's request body.

Field	Data type	Description
limit	int	Other such limit the image weight is considered overage in KB.
beautified	string Optional, default true	The weight is considered on beautified html or minified HTML

Example response for a check that passed

The following JSON response shows an example of an HTML weight overage check that passed. This means that within the email, an instance of a limit overage was not identified, and the end user can confidently export their design.

{
                    "type": "overageHtmlWeight",
                    "targets": [],
                    "maxWeight": 11.2,
                    "displayConditions": false,
                    "targetsCount": 0,
                    "checkStatus": "passed",
                    "processed": true,
                    "limit": 80
}

Example response for a check that returned a warning

The following JSON response shows an example of an HTML weight overage check that resulted in a warning. This means that within the email, an instance of an HTML weight overages was identified, and the end user should resolve the overage prior to exporting their design.

{
                    "type": "overageHtmlWeight",
                    "targets": [
                        {"weight": 11.2, "beautified": true},
                    ],
                    "maxWeight": 11.2,
                    "displayConditions": false,
                    "targetsCount": 1,
                    "checkStatus": "warning",
                    "processed": true,
                    "limit": 80
}                         

The following table lists and defines all the fields related to the overageHtmlWeight check.

Field	Data type	Description
type	string	Check type, equal to overageHtmlWeight
targetsCount	integer	The number of widgets miss alt text
checkStatus	string	The status of this check: passed or warning
maxWeight	float or null	The max weight on the generated html files. null if the parser does not response
displayConditions	boolean	If the given json includes display conditions
processed	boolean	If the check has been processed. It is false when the parser does not response
limit	integer	The limit given in the request
targets	array	The list of html files generated if the parser is responding and at least 1 has the weight other the limit
weight	float	The weight of the generated HTML in KB
beautified	boolean	If the coupled weight is related on beautified HTML

Missing Headings

This check verifies the presence of headings within the template. Headings matter because they give every reader—especially people using screen readers—a clear, navigable map of a template's content and hierarchy. If no heading are found, a warning will be issued.

Check details	Corresponding options
Type	Warning
Available for	email and page messages, email and page templates
Use data on widgets	heading
Use general features in JSON	--

On requests in checks list: {"category":"missingHeadings"}

Passed check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingHeadings",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": []
            }
        ],
        "checksFailedCount": 0,
        "checksWarningCount": 0,
        "checksSuggestionCount": 0,
        "status": "passed"
    }
]

Warning check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingHeadings",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "detailType": "no-heading"
                    }
                ]
            }
        ],
        "checksFailedCount": 1,
        "checksWarningCount": 1,
        "checksSuggestionCount": 0,
        "status": "warning"
    }
]

The following table lists and defines all the fields related to the missingHeadings check.

Field	Data type	Description
type	string	check type, equal to missingHeadings
targetsCount	integer	the number of missing headings warnings
checkStatus	string	the status of this check: passed or warning
targets	array	the list of missing headings warnings

Overage Headings

This check verifies whether the template contains a proper H1 heading.

• If no H1 is found, a suggestion is issued.

• If more than one H1 is found, a suggestion is also issued.

Check details	Corresponding options
Type	Suggestion
Available for	email and page messages, email and page templates
Use data on widgets	heading
Use general features in JSON	--

On requests in checks list: {"category":"overageHeadings"}

Passed check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "overageHeadings",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": []
            }
        ],
        "checksFailedCount": 0,
        "checksWarningCount": 0,
        "checksSuggestionCount": 0,
        "status": "passed"
    }
]

Suggestion check response - No H1 headings in the template

[
    {
        "language": "default",
        "checks": [
            {
                "type": "overageHeadings",
                "targetsCount": 1,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "detailType": "no-h1-heading"
                    }
                ]
            }
        ],
        "checksFailedCount": 1,
        "checksWarningCount": 0,
        "checksSuggestionCount": 1,
        "status": "suggestion"
    }
]

Suggestion check response - More than one H1 headings in the template

[
    {
        "language": "default",
        "checks": [
            {
                "type": "overageHeadings",
                "targetsCount": 2,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "5ea9388b-0dc5-4354-917d-638442bf63d2",
                        "widgetType": "heading",
                        "widgetLabel": "Title 1",
                        "locked": false,
                        "synced": false,
                        "title": "h1"
                    },
                    {
                        "uuid": "463d7acb-2e47-4b97-946b-8cd443af8eb0",
                        "widgetType": "heading",
                        "widgetLabel": "Title 2",
                        "locked": false,
                        "synced": false,
                        "title": "h1"
                    }
                ]
            }
        ],
        "checksFailedCount": 2,
        "checksWarningCount": 0,
        "checksSuggestionCount": 2,
        "status": "suggestion"
    }
]

The following table lists and defines all the fields related to the overageHeadings check.

Field	Data type	Description
type	string	check type, equal to overageHeadings
targetsCount	integer	the number of overage headings suggestions
checkStatus	string	the status of this check: passed or suggestion
targets	array	the list of overage headings suggestions
locked	boolean	if the heading widget is in a locked row
synced	boolean	if the heading widget is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	label of the heading widget
widgetType	string	heading
title	string	title of the heading widget

Missing Main Language

This check verifies the presence of the language property within the template (Settings > Metadata). The HTML language tag tells assistive technologies, like screen readers, what language the content is in, so words are pronounced correctly. If no language is set, a warning will be issued.

Check details	Corresponding Options
Type	Warning
Available for	email and page messages, email and page templates
Use data on widgets	--
Use general features in JSON	head

On requests in checks list: {"category":"missingMainLanguage"}

Passed check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingMainLanguage",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": []
            }
        ],
        "checksFailedCount": 0,
        "checksWarningCount": 0,
        "checksSuggestionCount": 0,
        "status": "passed"
    }
]

Warning check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingMainLanguage",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "detailType": "no-main-language"
                    }
                ]
            }
        ],
        "checksFailedCount": 1,
        "checksWarningCount": 1,
        "checksSuggestionCount": 0,
        "status": "warning"
    }
]

The following table lists and defines all the fields related to the missingMainLanguage check.

Field	Data type	Description
type	string	check type, equal to missingMainLanguage
targetsCount	integer	the number of missing main language warnings
checkStatus	string	the status of this check: passed or warning
targets	array	the list of missing main language warnings

Insufficient color contrast

This check identifies color contrast issues in selected widgets within the template. If one or more issues are detected, a warning is issued.

According to WCAG 2.0 Level AA:

• Normal text must have a contrast ratio of at least 4.5:1.

• Large-scale text (≥ 24px, or ≥ 19px bold) must have a contrast ratio of at least 3:1.

Check details	Corresponding options
Type	Warning
Available for	email and page messages, email and page templates, rows
Use data on widgets	button, heading, paragraph, list, menu, table, icon
Use general features in JSON	--

On requests in checks list: {"category":"insufficientColorContrast"}

Passed check response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "insufficientColorContrast",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": []
            }
        ],
        "checksFailedCount": 0,
        "checksWarningCount": 0,
        "checksSuggestionCount": 0,
        "status": "passed"
    }
]

Warning check response - More than one color contrast issue in the template

[
  {
    "type": "insufficientColorContrast",
    "targetsCount": 7,
    "checkStatus": "warning",
    "targets": [
      {
        "uuid": "82ce63d9-59ee-4eff-b20a-0b5e91c24f1e",
        "widgetType": "button",
        "widgetLabel": "Button",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#dddddd",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.36,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": []
      },
      {
        "uuid": "4e13d534-cf01-4156-92f4-90e7e6b77501",
        "widgetType": "heading",
        "widgetLabel": "I'm a new title block",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#dddddd",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.36,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": [
          {
            "text": "new",
            "backgroundColor": "#ffffff",
            "color": "#ffffaa"
          }
        ]
      },
      {
        "uuid": "aa51233c-ac08-453e-b5bc-44e6f06120a4",
        "widgetType": "paragraph",
        "widgetLabel": "I'm a new paragraph block.",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#dddddd",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.36,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": [
          {
            "text": "block",
            "backgroundColor": "#ffffff",
            "color": "#ffffaa"
          }
        ]
      },
      {
        "uuid": "236e9e85-bce5-4a11-809b-ce47def14c7b",
        "widgetType": "list",
        "widgetLabel": "This is an unordered list",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#dddddd",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.36,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": [
          {
            "text": "unordered",
            "backgroundColor": "#ffffff",
            "color": "#ffffaa"
          }
        ]
      },
      {
        "uuid": "d39e3e0f-d226-4c8e-a129-d72bc002c588",
        "widgetType": "menu",
        "widgetLabel": "menu entry 1",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#dddddd",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.36,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": []
      },
      {
        "uuid": "0c49cc0d-66f1-4ce1-a426-dde366b27308",
        "widgetType": "table-content",
        "widgetLabel": "Add text",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#cccccc",
            "backgroundColor": "#ffffff",
            "contrastRatio": 1.61,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": []
      },
      {
        "uuid": "0c49cc0d-66f1-4ce1-a426-dde366b27308",
        "widgetType": "table-header",
        "widgetLabel": "Add header text",
        "locked": false,
        "synced": false,
        "colors": [
          {
            "color": "#eeeeee",
            "backgroundColor": "#dddddd",
            "contrastRatio": 1.17,
            "label": "default"
          }
        ],
        "hasLinks": false,
        "tinyColorsList": []
      }
    ]
  }
]

The following table lists and defines all the fields related to the insufficientColorContrast check.

Field	Data type	Description
type	string	check type, equal to insufficientColorContrast
targetsCount	integer	the number of widgets with warnings
checkStatus	string	the status of this check: passed or warning
targets	array	the list of widgets with warnings
locked	boolean	if the widget is in a locked row
synced	boolean	if the widget is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	label of the widget
widgetType	string	button, heading
hasLinks	boolean	If the widget contains any link
tinyColorList	array	list of colors applied with tiny mce with warnings. Each element contains the following fields: color, backgroundColor, text
text	string	the text on which color with tiny mce is applied
colors	array	list of color pairs with warnings. Each element contains the following fields: backgroundColor, color, contrastRatio, label
backgroundColor	string	color in hexadecimal format
color	string	color in hexadecimal format
contrastRatio	float	contrast ratio between color and backgroundColor
label	string	description of the color pairs

Highlight unreachable web link

This check highlights web links that aren't working properly, helping users catch and fix broken links.

The reachability of a web link is checked using HEAD requests. A link is considered reachable if it returns an HTTP status code in the 2xx range.

If a link cannot be assessed, it is added to the ignored array. Each ignored element includes a reasons array, which lists one or more of the following values explaining why reachability could not be determined:

• missingChecked – required information was not available for the check

• missingRelated – related data needed for validation was missing

• notApplicable – the check did not apply to this case

• urlValidation – the URL itself was invalid

• allowList - link's web domain is included in allowed_hosts optional parameter

Check details	Corresponding options
Type	Warning
Available for	email and page messages, email and page templates, rows
Use data on widgets	button, social, menu, image, gif, sticker, icon, heading, paragraph, list, table
Use general features in JSON	--

On requests in checks list: {"category":"unreachableWebLink", "allowed_hosts": ["example.com", "otherexample.com"]}

allowed_hosts	list[str], Optional	A allowlist of domain hosts that should be excluded from reachability checks

Passed check response

{
      "type": "unreachableWebLink",
       "targetsCount": 0,
       "checkStatus": "passed",
       "targets": [],
       "passed": [
           {
               "checkedElement": "https://beefree.io",
               "locked": false,
               "synced": false,
               "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
               "widgetLabel": "icon-placeholder.png",
               "widgetType": "icon",
               "moduleIndex": 2,
               "subModuleIndex": 1
           }
       ],
       "ignored": [
           {
               "checkedElement": "",
               "locked": false,
               "reasons": ["missingChecked"],
               "synced": false,
               "uuid": "27386d37-df5b-4f5a-b3df-f3e8a2c9d640",
               "widgetLabel": "Menu item name",
               "widgetType": "menu",
               "moduleIndex": 1,
               "subModuleIndex": 1
           }
       ],
       "redirected": [
        {
            "checkedElement": "https://beefree.io/redirect-link",
            "locked": false,
            "synced": false,
            "uuid": "icons-uuid",
            "widgetLabel": "icon3-url.jpg",
            "widgetType": "icon",
            "moduleIndex": 3,
            "subModuleIndex": 1
        },
}

Warning check response

{
    "type": "unreachableWebLink",
    "targetsCount": 1,
    "checkStatus": "warning",
    "targets": [
        {
            "checkedElement": "https://beefree.io/unreachable-link",
            "locked": false,
            "synced": false,
            "uuid": "9c38bcc0-71a0-4baa-9b61-43b3c30a620d",
            "widgetLabel": "Button name 1",
            "widgetType": "button",
            "moduleIndex": 2,
            "subModuleIndex": 1
        }
    ],
    "passed": [
        {
            "checkedElement": "https://beefree.io",
            "locked": false,
            "synced": false,
            "uuid": "ab6589c0-414f-4075-ac31-28369511be4d",
            "widgetLabel": "icon-placeholder.png",
            "widgetType": "icon",
            "moduleIndex": 1,
            "subModuleIndex": 1
        }
    ],
    "ignored": [
        {
            "checkedElement": "beefree.io",
            "locked": false,
            "reasons": ["urlValidation"],
            "synced": false,
            "uuid": "27386d37-df5b-4f5a-b3df-f3e8a2c9d640",
            "widgetLabel": "Menu item name",
            "widgetType": "menu",
            "moduleIndex": 3,
            "subModuleIndex": 1
        }
    ],
    "redirected": [],
}

The following table lists and defines all the fields related to the unreachableWebLink check.

Field	Data type	Description
type	string	check type, equal to unreachableWebLink
targetsCount	integer	the number of unreachable web links
checkStatus	string	the status of this check: passed or warning
targets	array	the list of unreachable web links
passed	array	the list of reachable web links
ignored	array	the list of ignored links
redirected	array	the list of web links for which their response was a redirect response
locked	boolean	if the link is in a locked row
synced	boolean	if the link is in a synced row
uuid	string	uuid of the widget containing the link
widgetLabel	string	label of the element in the widget containing the link
widgetType	string	type of the widget: button, menu, social, image, gif, sticker, icon, heading, paragraph, list, table
reasons	array	For ignored elements, one or more of the following values: missingChecked, missingRelated, notApplicable, urlValidation, allowList
moduleIndex	int	a numeric value that defines an element’s position in the design and determines the order of elements
subModuleIndex	int	a numeric value used to define the order of elements relative to the moduleIndex

Insufficient Font Size

This check verifies if any widget in the template has a font size under 14px. If found, the user receives a suggestion.

Check details	Corresponding options
Type	Suggestion
Available for	email and page messages, email and page templates, rows
Use data on widgets	button, heading, paragraph, menu, list, table
Use general features in JSON	--

On requests in checks list: {"category":"insufficientFontSize"}

Passed check response

[
  {
    "language": "default",
    "checks": [
      {
        "type": "insufficientFontSize",
        "targetsCount": 0,
        "checkStatus": "passed",
        "targets": []
      }
    ],
    "checksFailedCount": 0,
    "checksWarningCount": 0,
    "checksSuggestionCount": 0,
    "status": "passed"
  }
]

Warning check response - Font Size Suggestion for multiple modules

[
  {
    "language": "default",
    "checks": [
      {
        "type": "insufficientFontSize",
        "targetsCount": 7,
        "checkStatus": "suggestion",
        "targets": [
          {
            "uuid": "c159b2b6-df0d-4747-a2e8-e32bafe5e710",
            "widgetType": "paragraph",
            "widgetLabel": "I'm a new paragraph block.",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "2fd4750b-9abb-47c1-a8c3-fae33a5f7350",
            "widgetType": "heading",
            "widgetLabel": "I'm a new title block",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "ec5d77f0-657f-45ff-bf6b-2b345a8218ec",
            "widgetType": "button",
            "widgetLabel": "Button",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "d8f5f12c-40c5-4789-b75a-a8732904b9c7",
            "widgetType": "menu",
            "widgetLabel": "menu 1, Menu 2",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "3fa39414-9224-44ff-8ff9-340332e9ecb1",
            "widgetType": "list",
            "widgetLabel": "First element, Second element, Third element",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "01f48a66-2414-4b9f-8f8f-e7d8f8ce1bb2",
            "widgetType": "table-header",
            "widgetLabel": "Add header text",
            "locked": false,
            "synced": false,
            "mode": "both"
          },
          {
            "uuid": "01f48a66-2414-4b9f-8f8f-e7d8f8ce1bb2",
            "widgetType": "table-content",
            "widgetLabel": "Add text",
            "locked": false,
            "synced": false,
            "mode": "both"
          }
        ]
      }
    ],
    "checksFailedCount": 7,
    "checksWarningCount": 0,
    "checksSuggestionCount": 7,
    "status": "suggestion"
  }
]

The following table lists the possible fields and their corresponding data types and descriptions.

Field	Data type	Description
type	string	check type, equal to insufficientFontSize
targetsCount	integer	the number of widgets with warnings
checkStatus	string	the status of this check: suggestion
targets	array	the list of widgets with warnings
locked	boolean	if the widget is in a locked row
synced	boolean	if the widget is in a synced row
uuid	string	uuid of the row containing this widget
widgetLabel	string	label of the widget
widgetType	string	button, heading, paragraph,menu,list,table-header, table-content
mode	string	Stage mode suggestions refer to: both : small font size set on desktop, mobile not set desktop: small font size set on desktop mobile: small font size set on mobile Note: If small font size is set both on desktop and on mobile two suggestion will be returned, one with mode: desktop and one with mode : mobile

Frontend Visual Feedback and Cues

This section discusses how to perform API calls on the backend in order to run checks against email, page, and row JSON. An important part of connecting the backend API calls to frontend feedback is the response body of these API calls. When a check is performed against the JSON, if an issue is identified, the target in the API response specifies the element that needs attention. This target is what connects to Frontend Commands, the execCommand method and actions (select, highlight, scroll, and focus), and provides feedback visually to the end users on the frontend.

The following code snippet provides an example email check response from an API call to the v1/message/check endpoint.

Example email check response (click to expand section)

Example response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingImageLink",
                "targetsCount": 4,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69",
                        "widgetType": "image",
                        "widgetLabel": "baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9",
                        "widgetType": "sticker",
                        "widgetLabel": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Custom",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "overageImageWeight",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false,
                        "weight": 3942.2
                    }
                ],
                "limit": 500,
                "evaluated": 10,
                "errored": 0
            },
            {
                "type": "missingDetailsEmail",
                "targetsCount": 2,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "detailType": "subject"
                    },
                    {
                        "detailType": "preheader"
                    }
                ]
            },
            {
                "type": "overageHtmlWeight",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": [],
                "limit": 80,
                "processed": true,
                "maxWeight": 14.94,
                "displayConditions": false
            }
        ],
        "checksFailedCount": 10,
        "status": "warning"
    },
    {
        "language": "it-IT",
        "checks": [
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingImageLink",
                "targetsCount": 1,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Custom",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd",
                        "widgetType": "button",
                        "widgetLabel": "Button italian",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 5,
        "status": "warning"
    }
]

Check Endpoints

This section lists and describes each of the Check endpoints. You can use this section to learn about endpoint and how they work. You can also test each endpoint in the interactive testing environment available by clicking Test it.

Email

This section includes details on how to make an API call using the email check endpoint. In the following environment, you can reference comprehensive endpoint details and use the interactive testing environment to get started with the endpoint.

Check Message JSON

post

Check a message JSON for missing alt text, image urls, copy links, and more. Use this endpoint with Frontend Commands to inform the end user where to correct what was reported in the check.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

languagesstring[]Required

An array of strings for languages

Responses

200

Successful response

application/json

objectOptional

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/message/check

POST /v1/message/check HTTP/1.1
Host: api.getbee.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16434

{
  "languages": [
    "it-IT"
  ],
  "checks": [
    {
      "category": "missingAltText"
    },
    {
      "category": "missingImageLink"
    },
    {
      "category": "missingCopyLink"
    },
    {
      "category": "overageImageWeight",
      "limit": 500
    },
    {
      "category": "missingDetailsEmail"
    },
    {
      "category": "overageHtmlWeight",
      "limit": 80,
      "beautified": true
    }
  ],
  "template": {
    "comments": {},
    "page": {
      "body": {
        "container": {
          "style": {
            "background-color": "#8e7777"
          }
        },
        "content": {
          "computedStyle": {
            "linkColor": "#3c09ec",
            "messageBackgroundColor": "#f5f5ef",
            "messageWidth": "700px"
          },
          "style": {
            "color": "#000000",
            "font-family": "Arial, Helvetica Neue, Helvetica, sans-serif"
          }
        },
        "type": "mailup-bee-page-properties",
        "webFonts": [
          {
            "fontFamily": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
            "name": "Cabin",
            "url": "https://fonts.googleapis.com/css2?family=Cabin:wght@100;200;300;400;500;600;700;800;900"
          }
        ]
      },
      "description": "",
      "rows": [
        {
          "columns": [
            {
              "grid-columns": 12,
              "modules": [
                {
                  "contentType": "image",
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "360px"
                    },
                    "image": {
                      "alt": "english gif",
                      "height": "640px",
                      "href": "",
                      "prefix": "",
                      "src": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian gif"
                        }
                      },
                      "type": "image",
                      "url": "https://giphy.com/gifs/moodman-funny-dog-cYZkY9HeKgofpQnOUl",
                      "width": "360px"
                    },
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "moduleInternal": {
                    "configurationUi": {
                      "external": {
                        "url": "https://addons-giphy.getbee.io/search/gifs"
                      }
                    },
                    "ctaLabel": "Browse Gifs",
                    "entity": "GIF",
                    "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGl2ZWxsb18xIiBkYXRhLW5hbWU9IkxpdmVsbG8gMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgMjUwMCAyNjQzLjM0Ij48dGl0bGU+Z2lmLWdpcGh5LW91dGxpbmUtdGlsZTwvdGl0bGU+PHBhdGggZD0iTTIzMTUsMjYxMi45MUgxODVWMjIuOTFIMTczMi4xM1YzMDguNjZoMjkxLjVWNTk0LjI5SDIzMTVabS0yMDQwLTkwSDIyMjVWNjg0LjI5SDE5MzMuNjNWMzk4LjY2aC0yOTEuNVYxMTIuOTFIMjc1Wm0xNzQ4LjYzLTE5NS43NUg0NzYuMzhWMzA4LjY2aDk2NC4zN1Y4ODBoNTgyLjg4Wm0tMTQ1Ny4yNS05MEgxOTMzLjYzVjk3MEgxMzUwLjc1VjM5OC42Nkg1NjYuMzhaIiBzdHlsZT0iZmlsbDojNTA1NjU5Ii8+PC9zdmc+",
                    "placeholder": "File is too large",
                    "uid": "b17dc240-b226-415c-af71-246fc51bd088"
                  },
                  "type": "mailup-bee-newsletter-modules-addon",
                  "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756"
                },
                {
                  "contentType": "image",
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "220px"
                    },
                    "image": {
                      "alt": "english sticker ",
                      "height": "220px",
                      "href": "",
                      "prefix": "",
                      "src": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian sticker"
                        }
                      },
                      "type": "image",
                      "url": "https://giphy.com/stickers/baruchgeuze-baby-tired-smh-tr4TTyG4BjxfDioymO",
                      "width": "220px"
                    },
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "moduleInternal": {
                    "configurationUi": {
                      "external": {
                        "url": "https://addons-giphy.getbee.io/search/stickers"
                      }
                    },
                    "ctaLabel": "Browse Stickers",
                    "entity": "STICKER",
                    "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj48dGl0bGU+c3RpY2tlcjwvdGl0bGU+PHBhdGggZD0iTTUxMS42NSwxOTUuNTRoMGMtMTEuNDQtNDUuNi0zNC04Ni4xNi02OC0xMTkuMjd2LS4wOUMzOTQuOSwyNy4xLDMyOS4zLDAsMjU5Ljg5LDBBMjU5Ljg0LDI1OS44NCwwLDAsMCwwLDI1OS44M2MwLDY5LjQxLDI3LjQ3LDEzNC42Niw3Ni41NSwxODMuNzRhMjU4LjQxLDI1OC40MSwwLDAsMCwxMjAsNjguMDl2MGMwLC4yMiwxLjI5LjM0LDIuMTYuMzRhMTAuMDcsMTAuMDcsMCwwLDAsNy4yNy0zLjExTDUwOSwyMDUuNzFBMTAuODksMTAuODksMCwwLDAsNTExLjY1LDE5NS41NFpNMTgwLDQzOS4xbDAtLjA1YTE5My44LDE5My44LDAsMCwxLTU4Ljg1LTQwLjQ4Yy03Ni41LTc2LjUtNzYuNS0yMDEsMC0yNzcuNDlhMTk2LjI1LDE5Ni4yNSwwLDAsMSwzMTgsNTguODZsLjA3LDBBMjU5Ljg5LDI1OS44OSwwLDAsMCwxODAsNDM5LjFabTI0LjYxLDQxYTIzOC43MiwyMzguNzIsMCwwLDEsMjM1LjItMjc4LjkyYzQuNzksMCw5LjYxLjE0LDE0LjQzLjQzYTI0MS41OCwyNDEuNTgsMCwwLDEsMjUuODcsM1pNNDYyLjQzLDE4MC45M2EyMTUsMjE1LDAsMCwwLTQ4Ljg1LTc0Ljg1Yy04NC43Ny04NC43Ny0yMjIuNzEtODQuNzctMzA3LjQ4LDBzLTg0Ljc3LDIyMi43MSwwLDMwNy40OEEyMTQuNzUsMjE0Ljc1LDAsMCwwLDE4MSw0NjIuNDFxMSwxMS45NCwzLjE3LDIzLjczYTIzOC42MywyMzguNjMsMCwxLDEsMzAyLTMwMkM0NzguMzEsMTgyLjY4LDQ3MC4zOCwxODEuNjIsNDYyLjQzLDE4MC45M1oiIHN0eWxlPSJmaWxsOiM1MDU2NTkiLz48L3N2Zz4=",
                    "placeholder": "File is too large",
                    "uid": "686279a5-1006-47a2-8d7b-6a69004e18ab"
                  },
                  "type": "mailup-bee-newsletter-modules-addon",
                  "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnDesktop": false,
                      "hideContentOnMobile": false,
                      "iconHeight": "32px",
                      "iconSpacing": {
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px"
                      },
                      "itemSpacing": "0px"
                    },
                    "iconsList": {
                      "icons": [
                        {
                          "alt": "",
                          "height": "64px",
                          "href": "",
                          "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                          "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                          "target": "_self",
                          "text": "english",
                          "textPosition": "right",
                          "title": "",
                          "width": "64px"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "icons": [
                            {
                              "alt": "",
                              "height": "64px",
                              "href": "",
                              "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                              "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                              "target": "_self",
                              "text": "italian",
                              "textPosition": "right",
                              "title": "",
                              "width": "64px"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "color": "#000000",
                      "font-family": "inherit",
                      "font-size": "14px",
                      "font-weight": "400",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-icons",
                  "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "height": 57,
                      "hideContentOnMobile": false,
                      "iconsDefaultWidth": 32,
                      "padding": "0 2.5px 0 2.5px",
                      "width": 151
                    },
                    "iconsList": {
                      "icons": [
                        {
                          "id": "linkedin",
                          "image": {
                            "alt": "linkedin",
                            "href": "https://www.linkedin.com/",
                            "prefix": "linkedin",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english linkedin"
                          },
                          "name": "linkedin",
                          "text": "linkedin",
                          "type": "follow"
                        },
                        {
                          "id": "instagram",
                          "image": {
                            "alt": "instagram",
                            "href": "https://www.instagram.com/",
                            "prefix": "instagram",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english instagram"
                          },
                          "name": "instagram",
                          "text": "instagram",
                          "type": "follow"
                        },
                        {
                          "id": "twitter",
                          "image": {
                            "alt": "Twitter",
                            "href": "https://www.twitter.com",
                            "prefix": "https://www.twitter.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english Twitter"
                          },
                          "name": "twitter",
                          "text": "Twitter",
                          "type": "follow"
                        },
                        {
                          "id": "tripadvisor",
                          "image": {
                            "alt": "Tripadvisor",
                            "href": "https://www.tripadvisor.com",
                            "prefix": "https://www.tripadvisor.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_blank",
                            "title": "english Tripadvisor"
                          },
                          "name": "Tripadvisor",
                          "text": "",
                          "type": "follow"
                        },
                        {
                          "image": {
                            "alt": "Custom",
                            "height": "",
                            "href": "",
                            "prefix": "",
                            "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                            "target": "_blank",
                            "title": "english Custom",
                            "width": ""
                          },
                          "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                          "text": "",
                          "type": "custom"
                        },
                        {
                          "id": "snapchat",
                          "image": {
                            "alt": "",
                            "href": "https://www.snapchat.com",
                            "prefix": "https://www.snapchat.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_blank",
                            "title": "english Snapchat"
                          },
                          "name": "Snapchat",
                          "text": "",
                          "type": "follow"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "icons": [
                            {
                              "id": "linkedin",
                              "image": {
                                "alt": "linkedin",
                                "href": "https://www.linkedin.com/",
                                "prefix": "linkedin",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian linkedin"
                              },
                              "name": "linkedin",
                              "text": "linkedin",
                              "type": "follow"
                            },
                            {
                              "id": "instagram",
                              "image": {
                                "alt": "instagram",
                                "href": "https://www.instagram.com/",
                                "prefix": "instagram",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian instagram"
                              },
                              "name": "instagram",
                              "text": "instagram",
                              "type": "follow"
                            },
                            {
                              "id": "twitter",
                              "image": {
                                "alt": "Twitter",
                                "href": "https://www.twitter.com",
                                "prefix": "https://www.twitter.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian Twitter"
                              },
                              "name": "twitter",
                              "text": "Twitter",
                              "type": "follow"
                            },
                            {
                              "id": "tripadvisor",
                              "image": {
                                "alt": "Tripadvisor",
                                "href": "https://www.tripadvisor.com",
                                "prefix": "https://www.tripadvisor.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_blank",
                                "title": "italian Tripadvisor"
                              },
                              "name": "Tripadvisor",
                              "text": "",
                              "type": "follow"
                            },
                            {
                              "image": {
                                "alt": "Custom",
                                "height": "",
                                "href": "",
                                "prefix": "",
                                "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                                "target": "_blank",
                                "title": "italian Custom",
                                "width": ""
                              },
                              "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                              "text": "",
                              "type": "custom"
                            },
                            {
                              "id": "snapchat",
                              "image": {
                                "alt": "",
                                "href": "https://www.snapchat.com",
                                "prefix": "https://www.snapchat.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_blank",
                                "title": "italian Snapchat"
                              },
                              "name": "Snapchat",
                              "text": "",
                              "type": "follow"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "40px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "40px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-social",
                  "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "700px"
                    },
                    "image": {
                      "alt": "english image",
                      "height": "853px",
                      "href": "",
                      "src": "https://d15k2d11r6t6rl.cloudfront.net/pub/bfra/rqqybms6/jcx/izz/k5l/baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian image"
                        }
                      },
                      "width": "1280px"
                    },
                    "mobileStyle": {},
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-image",
                  "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69"
                },
                {
                  "descriptor": {
                    "button": {
                      "href": "example.com/english",
                      "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button english</p></div>",
                      "style": {
                        "background-color": "#3b498f",
                        "border-bottom": "1px solid #8a3b8f",
                        "border-left": "1px solid #8a3b8f",
                        "border-radius": "4px",
                        "border-right": "1px solid #8a3b8f",
                        "border-top": "1px solid #8a3b8f",
                        "color": "#ffffff",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "200%",
                        "max-width": "100%",
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px",
                        "width": "auto"
                      },
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button italian</p></div>"
                        }
                      }
                    },
                    "computedStyle": {
                      "height": 44,
                      "hideContentOnMobile": false,
                      "width": 102
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "10px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "10px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-button",
                  "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hamburger": {
                        "backgroundColor": "#000000",
                        "foregroundColor": "#ffffff",
                        "iconSize": "36px",
                        "iconType": "normal",
                        "mobile": false
                      },
                      "hideContentOnDesktop": false,
                      "hideContentOnMobile": false,
                      "layout": "horizontal",
                      "linkColor": "#8a3c90",
                      "menuItemsSpacing": {
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px"
                      }
                    },
                    "menuItemsList": {
                      "items": [
                        {
                          "id": "a785a714-3191-434f-bea0-657f983f7a59",
                          "link": {
                            "href": "example.com",
                            "target": "_self",
                            "title": ""
                          },
                          "text": "english menu"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "items": [
                            {
                              "id": "a785a714-3191-434f-bea0-657f983f7a59",
                              "link": {
                                "href": "example.com",
                                "target": "_self",
                                "title": ""
                              },
                              "text": "italian menu"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "color": "#101112",
                      "font-family": "inherit",
                      "font-size": "16px",
                      "font-weight": "400",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-menu",
                  "uuid": "598ecce1-4b00-4484-bb47-bb6c3b5c6b07"
                },
                {
                  "descriptor": {
                    "heading": {
                      "style": {
                        "color": "#274daa",
                        "direction": "ltr",
                        "font-family": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "50px",
                        "font-weight": "700",
                        "letter-spacing": "1px",
                        "line-height": "150%",
                        "link-color": "#09eca4",
                        "text-align": "left"
                      },
                      "text": "<span class=\"tinyMce-placeholder\">I'm a new title block english</span>",
                      "title": "h1",
                      "translations": {
                        "it-IT": {
                          "text": "<span class=\"tinyMce-placeholder\">I'm a new title block italian</span>"
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "10px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "10px",
                      "text-align": "center",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-heading",
                  "uuid": "e18f9584-1396-4ff0-a6a5-0fb56ac92555"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnAmp": false,
                      "hideContentOnDesktop": false,
                      "hideContentOnHtml": false,
                      "hideContentOnMobile": false
                    },
                    "mobileStyle": {},
                    "paragraph": {
                      "computedStyle": {
                        "linkColor": "#3c09ec",
                        "paragraphSpacing": "16px"
                      },
                      "html": "<p>I'm a new paragraph block. english</p>",
                      "style": {
                        "color": "#393d47",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "180%",
                        "text-align": "left"
                      },
                      "translations": {
                        "it-IT": {
                          "html": "<p>I'm a new paragraph block. italian</p>"
                        }
                      }
                    },
                    "style": {
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-paragraph",
                  "uuid": "dbeb062e-f713-422b-a7d7-10df637c0c28"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnAmp": false,
                      "hideContentOnDesktop": false,
                      "hideContentOnHtml": false,
                      "hideContentOnMobile": false
                    },
                    "list": {
                      "computedStyle": {
                        "liIndent": "30px",
                        "liSpacing": "0px",
                        "linkColor": "#8a3b8f",
                        "listStylePosition": "inside",
                        "listStyleType": "revert",
                        "startList": "1"
                      },
                      "html": "<ul><li>This is an unordered list english</li></ul>",
                      "style": {
                        "color": "#393d47",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "180%",
                        "text-align": "left"
                      },
                      "tag": "ul",
                      "translations": {
                        "it-IT": {
                          "html": "<ul><li>This is an unordered list italian</li></ul>"
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-list",
                  "uuid": "12801c59-2a03-489e-b155-02c7ac843e74"
                }
              ],
              "style": {
                "background-color": "transparent",
                "border-bottom": "0px solid transparent",
                "border-left": "0px solid transparent",
                "border-right": "0px solid transparent",
                "border-top": "0px solid transparent",
                "padding-bottom": "5px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "5px"
              },
              "uuid": "56119ad2-574d-4122-8dd1-c1152b5f4879"
            }
          ],
          "container": {
            "style": {
              "background-color": "transparent",
              "background-image": "none",
              "background-position": "top left",
              "background-repeat": "no-repeat"
            }
          },
          "content": {
            "computedStyle": {
              "hideContentOnDesktop": false,
              "hideContentOnMobile": false,
              "rowColStackOnMobile": true,
              "rowReverseColStackOnMobile": false,
              "verticalAlign": "top"
            },
            "style": {
              "background-color": "#f5f5ef",
              "background-image": "none",
              "background-position": "top left",
              "background-repeat": "no-repeat",
              "color": "#000000",
              "width": "700px"
            }
          },
          "empty": false,
          "locked": false,
          "synced": false,
          "type": "one-column-empty",
          "uuid": "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"
        }
      ],
      "template": {
        "name": "template-base",
        "type": "basic",
        "version": "2.0.0"
      },
      "title": ""
    }
  }
}

{
  "message": "Success"
}

Example Email Response

Reference the following example email response:

[
    {
        "language": "default",
        "checks": [
            {
                "type": "overageImageWeight",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false,
                        "weight": 3942.2
                    }
                ],
                "limit": 500,
                "evaluated": 10,
                "errored": 0
            },
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Custom",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingDetailsEmail",
                "targetsCount": 2,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "detailType": "subject"
                    },
                    {
                        "detailType": "preheader"
                    }
                ]
            },
            {
                "type": "missingImageLink",
                "targetsCount": 4,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69",
                        "widgetType": "image",
                        "widgetLabel": "baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9",
                        "widgetType": "sticker",
                        "widgetLabel": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "overageHtmlWeight",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": [],
                "limit": 80,
                "processed": true,
                "maxWeight": 14.94,
                "displayConditions": false
            }
        ],
        "checksFailedCount": 10,
        "status": "warning"
    },
    {
        "language": "it-IT",
        "checks": [
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Custom",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd",
                        "widgetType": "button",
                        "widgetLabel": "Button italian",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingImageLink",
                "targetsCount": 1,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 5,
        "status": "warning"
    }
]

Page

This section includes details on how to make an API call using the page check endpoint. In the following environment, you can reference comprehensive endpoint details and use the interactive testing environment to get started with the endpoint.

Check Page JSON

post

Check a Page JSON for missing alt text, image urls, copy links, and more. Use this endpoint with Frontend Commands to inform the end user where to correct what was reported in the check.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

languagesstring[]Required

An array of strings for languages

Responses

200

Successful response

application/json

objectOptional

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/page/check

POST /v1/page/check HTTP/1.1
Host: api.getbee.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16371

{
  "languages": [
    "it-IT"
  ],
  "checks": [
    {
      "category": "missingAltText"
    },
    {
      "category": "missingImageLink"
    },
    {
      "category": "missingCopyLink"
    },
    {
      "category": "missingDetailsPage"
    },
    {
      "category": "overageImageWeight",
      "limit": 500
    }
  ],
  "template": {
    "comments": {},
    "page": {
      "body": {
        "container": {
          "style": {
            "background-color": "#8e7777"
          }
        },
        "content": {
          "computedStyle": {
            "linkColor": "#3c09ec",
            "messageBackgroundColor": "#f5f5ef",
            "messageWidth": "700px"
          },
          "style": {
            "color": "#000000",
            "font-family": "Arial, Helvetica Neue, Helvetica, sans-serif"
          }
        },
        "type": "mailup-bee-page-properties",
        "webFonts": [
          {
            "fontFamily": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
            "name": "Cabin",
            "url": "https://fonts.googleapis.com/css2?family=Cabin:wght@100;200;300;400;500;600;700;800;900"
          }
        ]
      },
      "description": "",
      "rows": [
        {
          "columns": [
            {
              "grid-columns": 12,
              "modules": [
                {
                  "contentType": "image",
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "360px"
                    },
                    "image": {
                      "alt": "english gif",
                      "height": "640px",
                      "href": "",
                      "prefix": "",
                      "src": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian gif"
                        }
                      },
                      "type": "image",
                      "url": "https://giphy.com/gifs/moodman-funny-dog-cYZkY9HeKgofpQnOUl",
                      "width": "360px"
                    },
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "moduleInternal": {
                    "configurationUi": {
                      "external": {
                        "url": "https://addons-giphy.getbee.io/search/gifs"
                      }
                    },
                    "ctaLabel": "Browse Gifs",
                    "entity": "GIF",
                    "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGl2ZWxsb18xIiBkYXRhLW5hbWU9IkxpdmVsbG8gMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgMjUwMCAyNjQzLjM0Ij48dGl0bGU+Z2lmLWdpcGh5LW91dGxpbmUtdGlsZTwvdGl0bGU+PHBhdGggZD0iTTIzMTUsMjYxMi45MUgxODVWMjIuOTFIMTczMi4xM1YzMDguNjZoMjkxLjVWNTk0LjI5SDIzMTVabS0yMDQwLTkwSDIyMjVWNjg0LjI5SDE5MzMuNjNWMzk4LjY2aC0yOTEuNVYxMTIuOTFIMjc1Wm0xNzQ4LjYzLTE5NS43NUg0NzYuMzhWMzA4LjY2aDk2NC4zN1Y4ODBoNTgyLjg4Wm0tMTQ1Ny4yNS05MEgxOTMzLjYzVjk3MEgxMzUwLjc1VjM5OC42Nkg1NjYuMzhaIiBzdHlsZT0iZmlsbDojNTA1NjU5Ii8+PC9zdmc+",
                    "placeholder": "File is too large",
                    "uid": "b17dc240-b226-415c-af71-246fc51bd088"
                  },
                  "type": "mailup-bee-newsletter-modules-addon",
                  "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756"
                },
                {
                  "contentType": "image",
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "220px"
                    },
                    "image": {
                      "alt": "english sticker ",
                      "height": "220px",
                      "href": "",
                      "prefix": "",
                      "src": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian sticker"
                        }
                      },
                      "type": "image",
                      "url": "https://giphy.com/stickers/baruchgeuze-baby-tired-smh-tr4TTyG4BjxfDioymO",
                      "width": "220px"
                    },
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "moduleInternal": {
                    "configurationUi": {
                      "external": {
                        "url": "https://addons-giphy.getbee.io/search/stickers"
                      }
                    },
                    "ctaLabel": "Browse Stickers",
                    "entity": "STICKER",
                    "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj48dGl0bGU+c3RpY2tlcjwvdGl0bGU+PHBhdGggZD0iTTUxMS42NSwxOTUuNTRoMGMtMTEuNDQtNDUuNi0zNC04Ni4xNi02OC0xMTkuMjd2LS4wOUMzOTQuOSwyNy4xLDMyOS4zLDAsMjU5Ljg5LDBBMjU5Ljg0LDI1OS44NCwwLDAsMCwwLDI1OS44M2MwLDY5LjQxLDI3LjQ3LDEzNC42Niw3Ni41NSwxODMuNzRhMjU4LjQxLDI1OC40MSwwLDAsMCwxMjAsNjguMDl2MGMwLC4yMiwxLjI5LjM0LDIuMTYuMzRhMTAuMDcsMTAuMDcsMCwwLDAsNy4yNy0zLjExTDUwOSwyMDUuNzFBMTAuODksMTAuODksMCwwLDAsNTExLjY1LDE5NS41NFpNMTgwLDQzOS4xbDAtLjA1YTE5My44LDE5My44LDAsMCwxLTU4Ljg1LTQwLjQ4Yy03Ni41LTc2LjUtNzYuNS0yMDEsMC0yNzcuNDlhMTk2LjI1LDE5Ni4yNSwwLDAsMSwzMTgsNTguODZsLjA3LDBBMjU5Ljg5LDI1OS44OSwwLDAsMCwxODAsNDM5LjFabTI0LjYxLDQxYTIzOC43MiwyMzguNzIsMCwwLDEsMjM1LjItMjc4LjkyYzQuNzksMCw5LjYxLjE0LDE0LjQzLjQzYTI0MS41OCwyNDEuNTgsMCwwLDEsMjUuODcsM1pNNDYyLjQzLDE4MC45M2EyMTUsMjE1LDAsMCwwLTQ4Ljg1LTc0Ljg1Yy04NC43Ny04NC43Ny0yMjIuNzEtODQuNzctMzA3LjQ4LDBzLTg0Ljc3LDIyMi43MSwwLDMwNy40OEEyMTQuNzUsMjE0Ljc1LDAsMCwwLDE4MSw0NjIuNDFxMSwxMS45NCwzLjE3LDIzLjczYTIzOC42MywyMzguNjMsMCwxLDEsMzAyLTMwMkM0NzguMzEsMTgyLjY4LDQ3MC4zOCwxODEuNjIsNDYyLjQzLDE4MC45M1oiIHN0eWxlPSJmaWxsOiM1MDU2NTkiLz48L3N2Zz4=",
                    "placeholder": "File is too large",
                    "uid": "686279a5-1006-47a2-8d7b-6a69004e18ab"
                  },
                  "type": "mailup-bee-newsletter-modules-addon",
                  "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnDesktop": false,
                      "hideContentOnMobile": false,
                      "iconHeight": "32px",
                      "iconSpacing": {
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px"
                      },
                      "itemSpacing": "0px"
                    },
                    "iconsList": {
                      "icons": [
                        {
                          "alt": "",
                          "height": "64px",
                          "href": "",
                          "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                          "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                          "target": "_self",
                          "text": "english",
                          "textPosition": "right",
                          "title": "",
                          "width": "64px"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "icons": [
                            {
                              "alt": "",
                              "height": "64px",
                              "href": "",
                              "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                              "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                              "target": "_self",
                              "text": "italian",
                              "textPosition": "right",
                              "title": "",
                              "width": "64px"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "color": "#000000",
                      "font-family": "inherit",
                      "font-size": "14px",
                      "font-weight": "400",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-icons",
                  "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "height": 57,
                      "hideContentOnMobile": false,
                      "iconsDefaultWidth": 32,
                      "padding": "0 2.5px 0 2.5px",
                      "width": 151
                    },
                    "iconsList": {
                      "icons": [
                        {
                          "id": "linkedin",
                          "image": {
                            "alt": "linkedin",
                            "href": "https://www.linkedin.com/",
                            "prefix": "linkedin",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english linkedin"
                          },
                          "name": "linkedin",
                          "text": "linkedin",
                          "type": "follow"
                        },
                        {
                          "id": "instagram",
                          "image": {
                            "alt": "instagram",
                            "href": "https://www.instagram.com/",
                            "prefix": "instagram",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english instagram"
                          },
                          "name": "instagram",
                          "text": "instagram",
                          "type": "follow"
                        },
                        {
                          "id": "twitter",
                          "image": {
                            "alt": "Twitter",
                            "href": "https://www.twitter.com",
                            "prefix": "https://www.twitter.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_self",
                            "title": "english Twitter"
                          },
                          "name": "twitter",
                          "text": "Twitter",
                          "type": "follow"
                        },
                        {
                          "id": "tripadvisor",
                          "image": {
                            "alt": "Tripadvisor",
                            "href": "https://www.tripadvisor.com",
                            "prefix": "https://www.tripadvisor.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_blank",
                            "title": "english Tripadvisor"
                          },
                          "name": "Tripadvisor",
                          "text": "",
                          "type": "follow"
                        },
                        {
                          "image": {
                            "alt": "Custom",
                            "height": "",
                            "href": "",
                            "prefix": "",
                            "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                            "target": "_blank",
                            "title": "english Custom",
                            "width": ""
                          },
                          "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                          "text": "",
                          "type": "custom"
                        },
                        {
                          "id": "snapchat",
                          "image": {
                            "alt": "",
                            "href": "https://www.snapchat.com",
                            "prefix": "https://www.snapchat.com",
                            "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                            "target": "_blank",
                            "title": "english Snapchat"
                          },
                          "name": "Snapchat",
                          "text": "",
                          "type": "follow"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "icons": [
                            {
                              "id": "linkedin",
                              "image": {
                                "alt": "linkedin",
                                "href": "https://www.linkedin.com/",
                                "prefix": "linkedin",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian linkedin"
                              },
                              "name": "linkedin",
                              "text": "linkedin",
                              "type": "follow"
                            },
                            {
                              "id": "instagram",
                              "image": {
                                "alt": "instagram",
                                "href": "https://www.instagram.com/",
                                "prefix": "instagram",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian instagram"
                              },
                              "name": "instagram",
                              "text": "instagram",
                              "type": "follow"
                            },
                            {
                              "id": "twitter",
                              "image": {
                                "alt": "Twitter",
                                "href": "https://www.twitter.com",
                                "prefix": "https://www.twitter.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_self",
                                "title": "italian Twitter"
                              },
                              "name": "twitter",
                              "text": "Twitter",
                              "type": "follow"
                            },
                            {
                              "id": "tripadvisor",
                              "image": {
                                "alt": "Tripadvisor",
                                "href": "https://www.tripadvisor.com",
                                "prefix": "https://www.tripadvisor.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_blank",
                                "title": "italian Tripadvisor"
                              },
                              "name": "Tripadvisor",
                              "text": "",
                              "type": "follow"
                            },
                            {
                              "image": {
                                "alt": "Custom",
                                "height": "",
                                "href": "",
                                "prefix": "",
                                "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                                "target": "_blank",
                                "title": "italian Custom",
                                "width": ""
                              },
                              "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                              "text": "",
                              "type": "custom"
                            },
                            {
                              "id": "snapchat",
                              "image": {
                                "alt": "",
                                "href": "https://www.snapchat.com",
                                "prefix": "https://www.snapchat.com",
                                "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                                "target": "_blank",
                                "title": "italian Snapchat"
                              },
                              "name": "Snapchat",
                              "text": "",
                              "type": "follow"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "40px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "40px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-social",
                  "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "class": "center autowidth",
                      "hideContentOnMobile": false,
                      "width": "700px"
                    },
                    "image": {
                      "alt": "english image",
                      "height": "853px",
                      "href": "",
                      "src": "https://d15k2d11r6t6rl.cloudfront.net/pub/bfra/rqqybms6/jcx/izz/k5l/baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "alt": "italian image"
                        }
                      },
                      "width": "1280px"
                    },
                    "mobileStyle": {},
                    "style": {
                      "border-radius": "0px",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-image",
                  "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69"
                },
                {
                  "descriptor": {
                    "button": {
                      "href": "example.com/english",
                      "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button english</p></div>",
                      "style": {
                        "background-color": "#3b498f",
                        "border-bottom": "1px solid #8a3b8f",
                        "border-left": "1px solid #8a3b8f",
                        "border-radius": "4px",
                        "border-right": "1px solid #8a3b8f",
                        "border-top": "1px solid #8a3b8f",
                        "color": "#ffffff",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "200%",
                        "max-width": "100%",
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px",
                        "width": "auto"
                      },
                      "target": "_blank",
                      "translations": {
                        "it-IT": {
                          "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button italian</p></div>"
                        }
                      }
                    },
                    "computedStyle": {
                      "height": 44,
                      "hideContentOnMobile": false,
                      "width": 102
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "10px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "10px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-button",
                  "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hamburger": {
                        "backgroundColor": "#000000",
                        "foregroundColor": "#ffffff",
                        "iconSize": "36px",
                        "iconType": "normal",
                        "mobile": false
                      },
                      "hideContentOnDesktop": false,
                      "hideContentOnMobile": false,
                      "layout": "horizontal",
                      "linkColor": "#8a3c90",
                      "menuItemsSpacing": {
                        "padding-bottom": "5px",
                        "padding-left": "5px",
                        "padding-right": "5px",
                        "padding-top": "5px"
                      }
                    },
                    "menuItemsList": {
                      "items": [
                        {
                          "id": "a785a714-3191-434f-bea0-657f983f7a59",
                          "link": {
                            "href": "example.com",
                            "target": "_self",
                            "title": ""
                          },
                          "text": "english menu"
                        }
                      ],
                      "translations": {
                        "it-IT": {
                          "items": [
                            {
                              "id": "a785a714-3191-434f-bea0-657f983f7a59",
                              "link": {
                                "href": "example.com",
                                "target": "_self",
                                "title": ""
                              },
                              "text": "italian menu"
                            }
                          ]
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "color": "#101112",
                      "font-family": "inherit",
                      "font-size": "16px",
                      "font-weight": "400",
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px",
                      "text-align": "center"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-menu",
                  "uuid": "598ecce1-4b00-4484-bb47-bb6c3b5c6b07"
                },
                {
                  "descriptor": {
                    "heading": {
                      "style": {
                        "color": "#274daa",
                        "direction": "ltr",
                        "font-family": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "50px",
                        "font-weight": "700",
                        "letter-spacing": "1px",
                        "line-height": "150%",
                        "link-color": "#09eca4",
                        "text-align": "left"
                      },
                      "text": "<span class=\"tinyMce-placeholder\">I'm a new title block english</span>",
                      "title": "h1",
                      "translations": {
                        "it-IT": {
                          "text": "<span class=\"tinyMce-placeholder\">I'm a new title block italian</span>"
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "10px",
                      "padding-left": "10px",
                      "padding-right": "10px",
                      "padding-top": "10px",
                      "text-align": "center",
                      "width": "100%"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-heading",
                  "uuid": "e18f9584-1396-4ff0-a6a5-0fb56ac92555"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnAmp": false,
                      "hideContentOnDesktop": false,
                      "hideContentOnHtml": false,
                      "hideContentOnMobile": false
                    },
                    "mobileStyle": {},
                    "paragraph": {
                      "computedStyle": {
                        "linkColor": "#3c09ec",
                        "paragraphSpacing": "16px"
                      },
                      "html": "<p>I'm a new paragraph block. english</p>",
                      "style": {
                        "color": "#393d47",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "180%",
                        "text-align": "left"
                      },
                      "translations": {
                        "it-IT": {
                          "html": "<p>I'm a new paragraph block. italian</p>"
                        }
                      }
                    },
                    "style": {
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-paragraph",
                  "uuid": "dbeb062e-f713-422b-a7d7-10df637c0c28"
                },
                {
                  "descriptor": {
                    "computedStyle": {
                      "hideContentOnAmp": false,
                      "hideContentOnDesktop": false,
                      "hideContentOnHtml": false,
                      "hideContentOnMobile": false
                    },
                    "list": {
                      "computedStyle": {
                        "liIndent": "30px",
                        "liSpacing": "0px",
                        "linkColor": "#8a3b8f",
                        "listStylePosition": "inside",
                        "listStyleType": "revert",
                        "startList": "1"
                      },
                      "html": "<ul><li>This is an unordered list english</li></ul>",
                      "style": {
                        "color": "#393d47",
                        "direction": "ltr",
                        "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                        "font-size": "16px",
                        "font-weight": "400",
                        "letter-spacing": "0px",
                        "line-height": "180%",
                        "text-align": "left"
                      },
                      "tag": "ul",
                      "translations": {
                        "it-IT": {
                          "html": "<ul><li>This is an unordered list italian</li></ul>"
                        }
                      }
                    },
                    "mobileStyle": {},
                    "style": {
                      "padding-bottom": "0px",
                      "padding-left": "0px",
                      "padding-right": "0px",
                      "padding-top": "0px"
                    }
                  },
                  "locked": false,
                  "type": "mailup-bee-newsletter-modules-list",
                  "uuid": "12801c59-2a03-489e-b155-02c7ac843e74"
                }
              ],
              "style": {
                "background-color": "transparent",
                "border-bottom": "0px solid transparent",
                "border-left": "0px solid transparent",
                "border-right": "0px solid transparent",
                "border-top": "0px solid transparent",
                "padding-bottom": "5px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "5px"
              },
              "uuid": "56119ad2-574d-4122-8dd1-c1152b5f4879"
            }
          ],
          "container": {
            "style": {
              "background-color": "transparent",
              "background-image": "none",
              "background-position": "top left",
              "background-repeat": "no-repeat"
            }
          },
          "content": {
            "computedStyle": {
              "hideContentOnDesktop": false,
              "hideContentOnMobile": false,
              "rowColStackOnMobile": true,
              "rowReverseColStackOnMobile": false,
              "verticalAlign": "top"
            },
            "style": {
              "background-color": "#f5f5ef",
              "background-image": "none",
              "background-position": "top left",
              "background-repeat": "no-repeat",
              "color": "#000000",
              "width": "700px"
            }
          },
          "empty": false,
          "locked": false,
          "synced": false,
          "type": "one-column-empty",
          "uuid": "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"
        }
      ],
      "template": {
        "name": "template-base",
        "type": "basic",
        "version": "2.0.0"
      },
      "title": ""
    }
  }
}

{
  "message": "Success"
}

Example Page Response

Reference an example page response:

[
    {
        "language": "default",
        "checks": [
            {
                "type": "missingImageLink",
                "targetsCount": 4,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69",
                        "widgetType": "image",
                        "widgetLabel": "baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9",
                        "widgetType": "sticker",
                        "widgetLabel": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingDetailsPage",
                "targetsCount": 0,
                "checkStatus": "passed",
                "targets": []
            },
            {
                "type": "overageImageWeight",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false,
                        "weight": 3942.2
                    }
                ],
                "limit": 500,
                "evaluated": 10,
                "errored": 0
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Custom",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 8,
        "status": "warning"
    },
    {
        "language": "it-IT",
        "checks": [
            {
                "type": "missingImageLink",
                "targetsCount": 1,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Custom",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd",
                        "widgetType": "button",
                        "widgetLabel": "Button italian",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 5,
        "status": "warning"
    }
]

Row

This section includes details on how to make an API call using the row check endpoint. In the following environment, you can reference comprehensive endpoint details and use the interactive testing environment to get started with the endpoint.

Check Row JSON

post

Check a row JSON for missing alt text, image urls, copy links, and more. Use this endpoint with Frontend Commands to inform the end user where to correct what was reported in the check.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

languagesstring[]Required

An array of strings for languages

Responses

200

Successful response

application/json

objectOptional

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/row/check

POST /v1/row/check HTTP/1.1
Host: api.getbee.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15707

{
  "languages": [
    "it-IT"
  ],
  "checks": [
    {
      "category": "missingAltText"
    },
    {
      "category": "missingImageLink"
    },
    {
      "category": "missingCopyLink"
    },
    {
      "category": "overageImageWeight",
      "limit": 500
    }
  ],
  "row": {
    "columns": [
      {
        "grid-columns": 12,
        "modules": [
          {
            "contentType": "image",
            "descriptor": {
              "computedStyle": {
                "class": "center autowidth",
                "hideContentOnMobile": false,
                "width": "360px"
              },
              "image": {
                "alt": "english gif",
                "height": "640px",
                "href": "",
                "prefix": "",
                "src": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                "target": "_blank",
                "translations": {
                  "it-IT": {
                    "alt": "italian gif"
                  }
                },
                "type": "image",
                "url": "https://giphy.com/gifs/moodman-funny-dog-cYZkY9HeKgofpQnOUl",
                "width": "360px"
              },
              "style": {
                "border-radius": "0px",
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px",
                "width": "100%"
              }
            },
            "locked": false,
            "moduleInternal": {
              "configurationUi": {
                "external": {
                  "url": "https://addons-giphy.getbee.io/search/gifs"
                }
              },
              "ctaLabel": "Browse Gifs",
              "entity": "GIF",
              "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGl2ZWxsb18xIiBkYXRhLW5hbWU9IkxpdmVsbG8gMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgMjUwMCAyNjQzLjM0Ij48dGl0bGU+Z2lmLWdpcGh5LW91dGxpbmUtdGlsZTwvdGl0bGU+PHBhdGggZD0iTTIzMTUsMjYxMi45MUgxODVWMjIuOTFIMTczMi4xM1YzMDguNjZoMjkxLjVWNTk0LjI5SDIzMTVabS0yMDQwLTkwSDIyMjVWNjg0LjI5SDE5MzMuNjNWMzk4LjY2aC0yOTEuNVYxMTIuOTFIMjc1Wm0xNzQ4LjYzLTE5NS43NUg0NzYuMzhWMzA4LjY2aDk2NC4zN1Y4ODBoNTgyLjg4Wm0tMTQ1Ny4yNS05MEgxOTMzLjYzVjk3MEgxMzUwLjc1VjM5OC42Nkg1NjYuMzhaIiBzdHlsZT0iZmlsbDojNTA1NjU5Ii8+PC9zdmc+",
              "placeholder": "File is too large",
              "uid": "b17dc240-b226-415c-af71-246fc51bd088"
            },
            "type": "mailup-bee-newsletter-modules-addon",
            "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756"
          },
          {
            "contentType": "image",
            "descriptor": {
              "computedStyle": {
                "class": "center autowidth",
                "hideContentOnMobile": false,
                "width": "220px"
              },
              "image": {
                "alt": "english sticker ",
                "height": "220px",
                "href": "",
                "prefix": "",
                "src": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                "target": "_blank",
                "translations": {
                  "it-IT": {
                    "alt": "italian sticker"
                  }
                },
                "type": "image",
                "url": "https://giphy.com/stickers/baruchgeuze-baby-tired-smh-tr4TTyG4BjxfDioymO",
                "width": "220px"
              },
              "style": {
                "border-radius": "0px",
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px",
                "width": "100%"
              }
            },
            "locked": false,
            "moduleInternal": {
              "configurationUi": {
                "external": {
                  "url": "https://addons-giphy.getbee.io/search/stickers"
                }
              },
              "ctaLabel": "Browse Stickers",
              "entity": "STICKER",
              "icon": "data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj48dGl0bGU+c3RpY2tlcjwvdGl0bGU+PHBhdGggZD0iTTUxMS42NSwxOTUuNTRoMGMtMTEuNDQtNDUuNi0zNC04Ni4xNi02OC0xMTkuMjd2LS4wOUMzOTQuOSwyNy4xLDMyOS4zLDAsMjU5Ljg5LDBBMjU5Ljg0LDI1OS44NCwwLDAsMCwwLDI1OS44M2MwLDY5LjQxLDI3LjQ3LDEzNC42Niw3Ni41NSwxODMuNzRhMjU4LjQxLDI1OC40MSwwLDAsMCwxMjAsNjguMDl2MGMwLC4yMiwxLjI5LjM0LDIuMTYuMzRhMTAuMDcsMTAuMDcsMCwwLDAsNy4yNy0zLjExTDUwOSwyMDUuNzFBMTAuODksMTAuODksMCwwLDAsNTExLjY1LDE5NS41NFpNMTgwLDQzOS4xbDAtLjA1YTE5My44LDE5My44LDAsMCwxLTU4Ljg1LTQwLjQ4Yy03Ni41LTc2LjUtNzYuNS0yMDEsMC0yNzcuNDlhMTk2LjI1LDE5Ni4yNSwwLDAsMSwzMTgsNTguODZsLjA3LDBBMjU5Ljg5LDI1OS44OSwwLDAsMCwxODAsNDM5LjFabTI0LjYxLDQxYTIzOC43MiwyMzguNzIsMCwwLDEsMjM1LjItMjc4LjkyYzQuNzksMCw5LjYxLjE0LDE0LjQzLjQzYTI0MS41OCwyNDEuNTgsMCwwLDEsMjUuODcsM1pNNDYyLjQzLDE4MC45M2EyMTUsMjE1LDAsMCwwLTQ4Ljg1LTc0Ljg1Yy04NC43Ny04NC43Ny0yMjIuNzEtODQuNzctMzA3LjQ4LDBzLTg0Ljc3LDIyMi43MSwwLDMwNy40OEEyMTQuNzUsMjE0Ljc1LDAsMCwwLDE4MSw0NjIuNDFxMSwxMS45NCwzLjE3LDIzLjczYTIzOC42MywyMzguNjMsMCwxLDEsMzAyLTMwMkM0NzguMzEsMTgyLjY4LDQ3MC4zOCwxODEuNjIsNDYyLjQzLDE4MC45M1oiIHN0eWxlPSJmaWxsOiM1MDU2NTkiLz48L3N2Zz4=",
              "placeholder": "File is too large",
              "uid": "686279a5-1006-47a2-8d7b-6a69004e18ab"
            },
            "type": "mailup-bee-newsletter-modules-addon",
            "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9"
          },
          {
            "descriptor": {
              "computedStyle": {
                "hideContentOnDesktop": false,
                "hideContentOnMobile": false,
                "iconHeight": "32px",
                "iconSpacing": {
                  "padding-bottom": "5px",
                  "padding-left": "5px",
                  "padding-right": "5px",
                  "padding-top": "5px"
                },
                "itemSpacing": "0px"
              },
              "iconsList": {
                "icons": [
                  {
                    "alt": "",
                    "height": "64px",
                    "href": "",
                    "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                    "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                    "target": "_self",
                    "text": "english",
                    "textPosition": "right",
                    "title": "",
                    "width": "64px"
                  }
                ],
                "translations": {
                  "it-IT": {
                    "icons": [
                      {
                        "alt": "",
                        "height": "64px",
                        "href": "",
                        "id": "d087217b-345a-4ebe-ac09-27c8ab0fdabd",
                        "image": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                        "target": "_self",
                        "text": "italian",
                        "textPosition": "right",
                        "title": "",
                        "width": "64px"
                      }
                    ]
                  }
                }
              },
              "mobileStyle": {},
              "style": {
                "color": "#000000",
                "font-family": "inherit",
                "font-size": "14px",
                "font-weight": "400",
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px",
                "text-align": "center"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-icons",
            "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085"
          },
          {
            "descriptor": {
              "computedStyle": {
                "height": 57,
                "hideContentOnMobile": false,
                "iconsDefaultWidth": 32,
                "padding": "0 2.5px 0 2.5px",
                "width": 151
              },
              "iconsList": {
                "icons": [
                  {
                    "id": "linkedin",
                    "image": {
                      "alt": "linkedin",
                      "href": "https://www.linkedin.com/",
                      "prefix": "linkedin",
                      "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                      "target": "_self",
                      "title": "english linkedin"
                    },
                    "name": "linkedin",
                    "text": "linkedin",
                    "type": "follow"
                  },
                  {
                    "id": "instagram",
                    "image": {
                      "alt": "instagram",
                      "href": "https://www.instagram.com/",
                      "prefix": "instagram",
                      "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                      "target": "_self",
                      "title": "english instagram"
                    },
                    "name": "instagram",
                    "text": "instagram",
                    "type": "follow"
                  },
                  {
                    "id": "twitter",
                    "image": {
                      "alt": "Twitter",
                      "href": "https://www.twitter.com",
                      "prefix": "https://www.twitter.com",
                      "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                      "target": "_self",
                      "title": "english Twitter"
                    },
                    "name": "twitter",
                    "text": "Twitter",
                    "type": "follow"
                  },
                  {
                    "id": "tripadvisor",
                    "image": {
                      "alt": "Tripadvisor",
                      "href": "https://www.tripadvisor.com",
                      "prefix": "https://www.tripadvisor.com",
                      "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                      "target": "_blank",
                      "title": "english Tripadvisor"
                    },
                    "name": "Tripadvisor",
                    "text": "",
                    "type": "follow"
                  },
                  {
                    "image": {
                      "alt": "Custom",
                      "height": "",
                      "href": "",
                      "prefix": "",
                      "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                      "target": "_blank",
                      "title": "english Custom",
                      "width": ""
                    },
                    "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                    "text": "",
                    "type": "custom"
                  },
                  {
                    "id": "snapchat",
                    "image": {
                      "alt": "",
                      "href": "https://www.snapchat.com",
                      "prefix": "https://www.snapchat.com",
                      "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                      "target": "_blank",
                      "title": "english Snapchat"
                    },
                    "name": "Snapchat",
                    "text": "",
                    "type": "follow"
                  }
                ],
                "translations": {
                  "it-IT": {
                    "icons": [
                      {
                        "id": "linkedin",
                        "image": {
                          "alt": "linkedin",
                          "href": "https://www.linkedin.com/",
                          "prefix": "linkedin",
                          "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                          "target": "_self",
                          "title": "italian linkedin"
                        },
                        "name": "linkedin",
                        "text": "linkedin",
                        "type": "follow"
                      },
                      {
                        "id": "instagram",
                        "image": {
                          "alt": "instagram",
                          "href": "https://www.instagram.com/",
                          "prefix": "instagram",
                          "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                          "target": "_self",
                          "title": "italian instagram"
                        },
                        "name": "instagram",
                        "text": "instagram",
                        "type": "follow"
                      },
                      {
                        "id": "twitter",
                        "image": {
                          "alt": "Twitter",
                          "href": "https://www.twitter.com",
                          "prefix": "https://www.twitter.com",
                          "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                          "target": "_self",
                          "title": "italian Twitter"
                        },
                        "name": "twitter",
                        "text": "Twitter",
                        "type": "follow"
                      },
                      {
                        "id": "tripadvisor",
                        "image": {
                          "alt": "Tripadvisor",
                          "href": "https://www.tripadvisor.com",
                          "prefix": "https://www.tripadvisor.com",
                          "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                          "target": "_blank",
                          "title": "italian Tripadvisor"
                        },
                        "name": "Tripadvisor",
                        "text": "",
                        "type": "follow"
                      },
                      {
                        "image": {
                          "alt": "Custom",
                          "height": "",
                          "href": "",
                          "prefix": "",
                          "src": "https://app-rsrc.getbee.io/public/resources/placeholders/custom-icon-placeholder.png",
                          "target": "_blank",
                          "title": "italian Custom",
                          "width": ""
                        },
                        "name": "9b6dbe22-59a9-4c8d-b2e3-601cfdee8f12",
                        "text": "",
                        "type": "custom"
                      },
                      {
                        "id": "snapchat",
                        "image": {
                          "alt": "",
                          "href": "https://www.snapchat.com",
                          "prefix": "https://www.snapchat.com",
                          "src": "https://app-rsrc.getbee.io/public/resources/social-networks-icon-sets/t-only-logo-dark-gray/[e-mail]",
                          "target": "_blank",
                          "title": "italian Snapchat"
                        },
                        "name": "Snapchat",
                        "text": "",
                        "type": "follow"
                      }
                    ]
                  }
                }
              },
              "mobileStyle": {},
              "style": {
                "padding-bottom": "40px",
                "padding-left": "10px",
                "padding-right": "10px",
                "padding-top": "40px",
                "text-align": "center"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-social",
            "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561"
          },
          {
            "descriptor": {
              "computedStyle": {
                "class": "center autowidth",
                "hideContentOnMobile": false,
                "width": "700px"
              },
              "image": {
                "alt": "english image",
                "height": "853px",
                "href": "",
                "src": "https://d15k2d11r6t6rl.cloudfront.net/pub/bfra/rqqybms6/jcx/izz/k5l/baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                "target": "_blank",
                "translations": {
                  "it-IT": {
                    "alt": "italian image"
                  }
                },
                "width": "1280px"
              },
              "mobileStyle": {},
              "style": {
                "border-radius": "0px",
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px",
                "width": "100%"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-image",
            "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69"
          },
          {
            "descriptor": {
              "button": {
                "href": "example.com/english",
                "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button english</p></div>",
                "style": {
                  "background-color": "#3b498f",
                  "border-bottom": "1px solid #8a3b8f",
                  "border-left": "1px solid #8a3b8f",
                  "border-radius": "4px",
                  "border-right": "1px solid #8a3b8f",
                  "border-top": "1px solid #8a3b8f",
                  "color": "#ffffff",
                  "direction": "ltr",
                  "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                  "font-size": "16px",
                  "font-weight": "400",
                  "letter-spacing": "0px",
                  "line-height": "200%",
                  "max-width": "100%",
                  "padding-bottom": "5px",
                  "padding-left": "5px",
                  "padding-right": "5px",
                  "padding-top": "5px",
                  "width": "auto"
                },
                "target": "_blank",
                "translations": {
                  "it-IT": {
                    "label": "<div class=\"txtTinyMce-wrapper\" style=\"font-family: inherit;\" data-mce-style=\"font-family: inherit;\"><p style=\"word-break: break-word;\" data-mce-style=\"word-break: break-word;\">Button italian</p></div>"
                  }
                }
              },
              "computedStyle": {
                "height": 44,
                "hideContentOnMobile": false,
                "width": 102
              },
              "mobileStyle": {},
              "style": {
                "padding-bottom": "10px",
                "padding-left": "10px",
                "padding-right": "10px",
                "padding-top": "10px",
                "text-align": "center"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-button",
            "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd"
          },
          {
            "descriptor": {
              "computedStyle": {
                "hamburger": {
                  "backgroundColor": "#000000",
                  "foregroundColor": "#ffffff",
                  "iconSize": "36px",
                  "iconType": "normal",
                  "mobile": false
                },
                "hideContentOnDesktop": false,
                "hideContentOnMobile": false,
                "layout": "horizontal",
                "linkColor": "#8a3c90",
                "menuItemsSpacing": {
                  "padding-bottom": "5px",
                  "padding-left": "5px",
                  "padding-right": "5px",
                  "padding-top": "5px"
                }
              },
              "menuItemsList": {
                "items": [
                  {
                    "id": "a785a714-3191-434f-bea0-657f983f7a59",
                    "link": {
                      "href": "example.com",
                      "target": "_self",
                      "title": ""
                    },
                    "text": "english menu"
                  }
                ],
                "translations": {
                  "it-IT": {
                    "items": [
                      {
                        "id": "a785a714-3191-434f-bea0-657f983f7a59",
                        "link": {
                          "href": "example.com",
                          "target": "_self",
                          "title": ""
                        },
                        "text": "italian menu"
                      }
                    ]
                  }
                }
              },
              "mobileStyle": {},
              "style": {
                "color": "#101112",
                "font-family": "inherit",
                "font-size": "16px",
                "font-weight": "400",
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px",
                "text-align": "center"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-menu",
            "uuid": "598ecce1-4b00-4484-bb47-bb6c3b5c6b07"
          },
          {
            "descriptor": {
              "heading": {
                "style": {
                  "color": "#274daa",
                  "direction": "ltr",
                  "font-family": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
                  "font-size": "50px",
                  "font-weight": "700",
                  "letter-spacing": "1px",
                  "line-height": "150%",
                  "link-color": "#09eca4",
                  "text-align": "left"
                },
                "text": "<span class=\"tinyMce-placeholder\">I'm a new title block english</span>",
                "title": "h1",
                "translations": {
                  "it-IT": {
                    "text": "<span class=\"tinyMce-placeholder\">I'm a new title block italian</span>"
                  }
                }
              },
              "mobileStyle": {},
              "style": {
                "padding-bottom": "10px",
                "padding-left": "10px",
                "padding-right": "10px",
                "padding-top": "10px",
                "text-align": "center",
                "width": "100%"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-heading",
            "uuid": "e18f9584-1396-4ff0-a6a5-0fb56ac92555"
          },
          {
            "descriptor": {
              "computedStyle": {
                "hideContentOnAmp": false,
                "hideContentOnDesktop": false,
                "hideContentOnHtml": false,
                "hideContentOnMobile": false
              },
              "mobileStyle": {},
              "paragraph": {
                "computedStyle": {
                  "linkColor": "#3c09ec",
                  "paragraphSpacing": "16px"
                },
                "html": "<p>I'm a new paragraph block. english</p>",
                "style": {
                  "color": "#393d47",
                  "direction": "ltr",
                  "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                  "font-size": "16px",
                  "font-weight": "400",
                  "letter-spacing": "0px",
                  "line-height": "180%",
                  "text-align": "left"
                },
                "translations": {
                  "it-IT": {
                    "html": "<p>I'm a new paragraph block. italian</p>"
                  }
                }
              },
              "style": {
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-paragraph",
            "uuid": "dbeb062e-f713-422b-a7d7-10df637c0c28"
          },
          {
            "descriptor": {
              "computedStyle": {
                "hideContentOnAmp": false,
                "hideContentOnDesktop": false,
                "hideContentOnHtml": false,
                "hideContentOnMobile": false
              },
              "list": {
                "computedStyle": {
                  "liIndent": "30px",
                  "liSpacing": "0px",
                  "linkColor": "#8a3b8f",
                  "listStylePosition": "inside",
                  "listStyleType": "revert",
                  "startList": "1"
                },
                "html": "<ul><li>This is an unordered list english</li></ul>",
                "style": {
                  "color": "#393d47",
                  "direction": "ltr",
                  "font-family": "'Cabin', Arial, 'Helvetica Neue', Helvetica, sans-serif",
                  "font-size": "16px",
                  "font-weight": "400",
                  "letter-spacing": "0px",
                  "line-height": "180%",
                  "text-align": "left"
                },
                "tag": "ul",
                "translations": {
                  "it-IT": {
                    "html": "<ul><li>This is an unordered list italian</li></ul>"
                  }
                }
              },
              "mobileStyle": {},
              "style": {
                "padding-bottom": "0px",
                "padding-left": "0px",
                "padding-right": "0px",
                "padding-top": "0px"
              }
            },
            "locked": false,
            "type": "mailup-bee-newsletter-modules-list",
            "uuid": "12801c59-2a03-489e-b155-02c7ac843e74"
          }
        ],
        "style": {
          "background-color": "transparent",
          "border-bottom": "0px solid transparent",
          "border-left": "0px solid transparent",
          "border-right": "0px solid transparent",
          "border-top": "0px solid transparent",
          "padding-bottom": "5px",
          "padding-left": "0px",
          "padding-right": "0px",
          "padding-top": "5px"
        },
        "uuid": "56119ad2-574d-4122-8dd1-c1152b5f4879"
      }
    ],
    "container": {
      "style": {
        "background-color": "transparent",
        "background-image": "none",
        "background-position": "top left",
        "background-repeat": "no-repeat"
      }
    },
    "content": {
      "computedStyle": {
        "hideContentOnDesktop": false,
        "hideContentOnMobile": false,
        "rowColStackOnMobile": true,
        "rowReverseColStackOnMobile": false,
        "verticalAlign": "top"
      },
      "style": {
        "background-color": "#f5f5ef",
        "background-image": "none",
        "background-position": "top left",
        "background-repeat": "no-repeat",
        "color": "#000000",
        "width": "700px"
      }
    },
    "empty": false,
    "locked": false,
    "synced": false,
    "type": "one-column-empty",
    "uuid": "0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"
  }
}

{
  "message": "Success"
}

Example row response

Reference an example row response

[
    {
        "language": "default",
        "checks": [
            {
                "type": "overageImageWeight",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false,
                        "weight": 3942.2
                    }
                ],
                "limit": 500,
                "evaluated": 10,
                "errored": 0
            },
            {
                "type": "missingImageLink",
                "targetsCount": 4,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "b17e02eb-f92d-4c1c-b012-a1c91a865756",
                        "widgetType": "gif",
                        "widgetLabel": "https://media1.giphy.com/media/v1.Y2lkPTIwZWI0ZTlkbmtibHF4emFxbTdmZjlzdmZ6M3ptaWxhb2xxdzc4cm1nZ2gxZnI3eSZlcD12MV9naWZzX3RyZW5kaW5nJmN0PWc/cYZkY9HeKgofpQnOUl/giphy.gif",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "1f4850b4-4146-4649-95ef-17c40214ce69",
                        "widgetType": "image",
                        "widgetLabel": "baseball-usa-lol-lol-lol-lol-lol-6557888.jpg",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "231445c3-8b29-44fc-8c36-08f734bdacb9",
                        "widgetType": "sticker",
                        "widgetLabel": "https://media3.giphy.com/media/tr4TTyG4BjxfDioymO/giphy.gif?cid=20eb4e9d0msqngsoluirfx8m5m93cqwa5xyj7l0lkud65cmo&ep=v1_stickers_trending&rid=giphy.gif&ct=s",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 1,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "english Custom",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 8,
        "status": "warning"
    },
    {
        "language": "it-IT",
        "checks": [
            {
                "type": "missingImageLink",
                "targetsCount": 1,
                "checkStatus": "suggestion",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingAltText",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "8c2fda6f-3fe2-4e04-9018-72ee4c348085",
                        "widgetType": "icon",
                        "widgetLabel": "custom-icon-placeholder.png",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Snapchat",
                        "locked": false,
                        "synced": false
                    }
                ]
            },
            {
                "type": "missingCopyLink",
                "targetsCount": 2,
                "checkStatus": "warning",
                "targets": [
                    {
                        "uuid": "ec01e2b4-5716-455c-a8ef-732a8e0ff561",
                        "widgetType": "social",
                        "widgetLabel": "italian Custom",
                        "locked": false,
                        "synced": false
                    },
                    {
                        "uuid": "df1b6f51-d8a7-43ae-a5b9-7699918eccdd",
                        "widgetType": "button",
                        "widgetLabel": "Button italian",
                        "locked": false,
                        "synced": false
                    }
                ]
            }
        ],
        "checksFailedCount": 5,
        "status": "warning"
    }
]