Sign inGet Started

Validate a reusable email section

POST
/v1/email/blocks/validate
// Requires email_management:read permission in the target workspace.
const section =
  '<table role="presentation" width="100%" cellpadding="0" cellspacing="0" border="0"><tbody><tr>' +
  '<td lang="en" style="font-family: Arial, sans-serif; font-size: 14px; font-style: normal; font-weight: normal; ' +
  "line-height: 20px; letter-spacing: normal; text-align: left; text-transform: none; color: #333333; margin: 0; padding: 16px;\">" +
  '<p style="margin: 0;">Offer valid until {{ expiry_date }}.</p></td></tr></tbody></table>';
const result = await bird.email.blocks.validate({
  language: "en",
  fragment: { serializer_version: 2, fragment_html: section },
});
console.log(result.text);

Checks a section against the rules applied when it is published: its structure and the content cell's typography, balanced Liquid, and registered contact properties. Contact properties are checked only for a caller with contact read access; without it, validation says nothing about them, and publication still refuses a property that is not registered or is archived. Returns the plain text derived from the section, or a 422 validation_error naming each field to correct. Nothing is saved or published. Each call computes a fresh result: an Idempotency-Key header is accepted but does not replay an earlier result.

Payload Permintaan

language
string
wajib

A language tag in BCP-47 form, for example en or pt-BR.

fragment
object
wajib

One self-contained email section. Version 2 is a section written as HTML and sends fragment_html alone; the API, SDKs, CLI and MCP write version 2. Version 1 is reserved for sections built in the Bird dashboard's visual editor, and only the dashboard saves it. A block language keeps the version it was created with.

Tampilkan parameter turunan

Payload Respons

text
string
wajib

Plain text derived from this section's HTML.