Campaigns Version: v3 New
Validate Email Campaign Before Sending
POST / emails / locations / {locationId} / campaigns / emails / {campaignId} / validate Try it
Inspect rendered HTML and intended sender metadata for missing subject, sender, unsubscribe link, broken placeholders, merge field syntax the send cannot parse (INVALID_MERGE_FIELD_SYNTAX) and unresolved fields. Optional overrides are checked without saving. ready means no content errors. Warns with SENDER_DOMAIN_NOT_VERIFIED when the sender is not on a location sending domain (see List Sending Domains); it does not verify delivery.
Authorizations Authorization string header required
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope: emails/ campaigns. readonly
Auth methods: OAuthPrivate Integration
Token type: Sub-Account Token
Request
Headers Version string required
Available options v3
Example: v3
Path Parameters locationId string required
Example: ve9EPM428h8vShlRW1KT
campaignId string required
Example: 67f15c2ae99226d5bcccb8f3
subject string
Subject to use for this request. Omit to use the stored subject; an empty string fails send validation.
Example: Holiday sale starts now
fromName string
Sender display name for this request. Defaults to the stored sender name; empty string omits the display name.
Example: Anz Studio
fromEmail string
Sender email address for this request. Must be a valid email address. Defaults to the stored fromAddress.
ready boolean required
True only when there are no errors. This is a content check, not a delivery or sender-domain verification guarantee.
Example: false
errors object[] required
Blocking issues that must be corrected before sending.
Show child attributeserrors[]. codestring required
Stable machine-readable check code, for example MISSING_SUBJECT or INVALID_LINK.
Example: INVALID_LINK
errors[]. messagestring required
Explanation of the problem and what to correct before sending.
Example: Replace the empty, unsafe or placeholder link.
errors[]. detailstring
Offending URL or unresolved merge token. Empty string identifies an empty URL.
Example: #
errors[]. variationIndexnumber
A/B version the issue belongs to (1 = version B, 2 = version C, ...). Omitted for version A.
Example: 1
warnings object[] required
Non-blocking issues worth reviewing before sending.
Show child attributeswarnings[]. codestring required
Stable machine-readable check code, for example MISSING_SUBJECT or INVALID_LINK.
Example: INVALID_LINK
warnings[]. messagestring required
Explanation of the problem and what to correct before sending.
Example: Replace the empty, unsafe or placeholder link.
warnings[]. detailstring
Offending URL or unresolved merge token. Empty string identifies an empty URL.
Example: #
warnings[]. variationIndexnumber
A/B version the issue belongs to (1 = version B, 2 = version C, ...). Omitted for version A.
Example: 1
summary object required
Effective metadata and counts for the inspected rendered HTML.
Show child attributessummary. subjectstring required
Effective subject after applying request overrides.
Example: Holiday sale starts now
summary. fromNamestring required
Effective sender display name after applying request overrides.
Example: Anz Studio
summary. fromEmailstring required
Effective sender email after applying request overrides.
summary. linkCountnumber required
Number of anchor elements in the rendered HTML, including unsubscribe links.
Example: 4
summary. imageCountnumber required
Number of image elements in the rendered HTML.
Example: 2
unresolvedMergeFields string[] required
All distinct {{...}} tokens found, including standard send-time tokens which do not produce warnings.
Example: ["{{contact.first_name}}"]