Send a test emailMenu

Send a test email

POST/v1/templates/test-send

Requires an API key with the templates:write scope. About keys and scopes

Works with integration and partner keys, not agent keys. Also available to embed sessions.

A repeat without a key does it again; send Idempotency-Key and a retry within 24 hours replays the first response. About idempotency

Sends the design or HTML in the request to one workspace member who has accepted their invitation; call once per recipient. Pass contact to render merge tags as that contact would see them. The test comes from from, or the workspace's default sender, on a verified sending domain: there is no shared sender, so a workspace sends tests once its own domain is verified (SENDING_DOMAIN_UNVERIFIED before then). A design with a button or video that has no working link is refused (DRAFT_INCOMPLETE, naming each one). Nothing is recorded as a message. An embed session may call this too: a session lets the chosen builders read what they need, render previews, count audiences, upload images and, when testSendTo lists addresses, send test emails to those addresses only. It never saves, publishes or sends anything else; your server saves what the builders return. From a session, the test goes only to an address its testSendTo names, instead of to a workspace member (400 VALIDATION_ERROR for any other).

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Idempotency-Keystringoptional

Makes a retry safe: a repeat with the same key and body within 24 hours gets the first response again, with Idempotency-Replay: true. The same key with another request is 409 IDEMPOTENCY_KEY_REUSED; while the first is still running, 409 IDEMPOTENCY_KEY_IN_USE; after an unsafe first request failed or never returned, 409 IDEMPOTENCY_KEY_OUTCOME_UNKNOWN. Use a new key, such as a UUID, for each new request.

8–255 characters

Request body

One of 2 shapes:

SendDesignTemplateTestInput

11 child attributes

kind"design"optional

design: built from blocks in the designer. Left out, design.

schemaVersionintegeroptional

The block format version.

min > 0 · max 1000

blocksobject[]required

The blocks, rendered top to bottom: at most 200 across the whole tree and five levels including the root. The footer stays at the root.

at least 1 item · at most 200 items

One of 23 shapes

HeaderBlockInput

11 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"header"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

A font id: one every client has (arial, verdana, georgia, tahoma, times-new-roman, courier-new), or a web font, which shows where the client loads it and falls back to a safe font elsewhere. Form themes use the same ids.

one of arial, verdana, georgia, tahoma, times-new-roman, courier-new, inter, roboto, open-sans, lato, montserrat, poppins, dm-sans, nunito, work-sans, oswald, ubuntu, mulish, manrope, quicksand, rubik, josefin-sans, epilogue, noto-sans, space-grotesk, plus-jakarta-sans, outfit, bricolage-grotesque, sora, ibm-plex-sans, geist, space-mono, playfair-display, merriweather, lora, libre-baskerville, eb-garamond, fraunces, source-serif-4, cormorant-garamond

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

srcstringoptional

The logo image's URL; without one, the brand kit's logo.

up to 2,048 characters

altstringoptional

The logo's alt text. Without src or a brand kit logo, it shows as a wordmark in the heading font; gallery samples set it to {{ org.name }}.

up to 100,000 characters

widthstringoptional

A share of the row ("100%", "66%", "50%"), or a fixed width from "16px" to "600px", such as "120px" for a logo. Never wider than the row.

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

hrefstringoptional

Where it links: an https:, http:, mailto: or tel: address, or a merge tag. https:// is added to a bare address such as acme.com/setup. A draft may hold anything; a button or video whose link is none of these cannot be published or sent.

up to 2,048 characters

HeadingBlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"heading"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

sizestringoptional

one of 28px, 22px, 18px

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

weightstringoptional

one of regular, bold

TextBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"text"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

ImageBlockInput

11 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"image"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

srcstringoptional

up to 2,048 characters

altstringoptional

up to 100,000 characters

widthstringoptional

A share of the row ("100%", "66%", "50%"), or a fixed width from "16px" to "600px", such as "120px" for a logo. Never wider than the row.

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

hrefstringoptional

up to 2,048 characters

ButtonBlockInput

12 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"button"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

hrefstringoptional

up to 2,048 characters

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

fullWidthbooleanoptional

colorstringoptional

A hex colour, or a theme reference: accent, canvas, or accent-tint / canvas-tint (a light tint of it), which follows the theme.

buttonStylestringoptional

This button's style, in place of the theme's.

one of solid, outline

DividerBlockInput

11 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"divider"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

thicknessintegeroptional

Line weight in px.

min 1 · max 10

colorstringoptional

A hex colour, or a theme reference: accent, canvas, or accent-tint / canvas-tint (a light tint of it), which follows the theme.

lineStylestringoptional

one of solid, dashed, dotted

widthstringoptional

How much of the row the line spans.

one of 100%, 75%, 50%, 25%

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

SpacerBlockInput

7 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"spacer"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

sizestringoptional

The height, from "4px" to "200px".

pattern ^\d{1,3}px$

ColumnsBlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"columns"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

widthsinteger[]optional

Each column's share of the row in percent, left to right, one per column and adding up to 100, such as [33, 67]. Omit for equal columns.

at least 2 items · at most 2 items

valignstringoptional

Where shorter columns sit against the tallest one.

one of top, middle, bottom

stackOnMobilebooleanoptional

False keeps the columns side by side on phones too, such as a two-across product grid; by default they stack.

columnsobject[][]required

The child blocks of each column, left to right: exactly 2 arrays.

at least 2 items · at most 2 items

Columns3BlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"columns3"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

widthsinteger[]optional

Each column's share of the row in percent, left to right, one per column and adding up to 100, such as [33, 67]. Omit for equal columns.

at least 3 items · at most 3 items

valignstringoptional

Where shorter columns sit against the tallest one.

one of top, middle, bottom

stackOnMobilebooleanoptional

False keeps the columns side by side on phones too, such as a two-across product grid; by default they stack.

columnsobject[][]required

The child blocks of each column, left to right: exactly 3 arrays.

at least 3 items · at most 3 items

ImageTextBlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"imagetext"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

srcstringoptional

up to 2,048 characters

altstringoptional

up to 100,000 characters

textstringoptional

up to 100,000 characters

sidestringoptional

Which side the image sits on; unset, the start of the reading direction (left, or right in a right-to-left language).

one of left, right

ImageGroupBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"imagegroup"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

count2 | 3optional

imagesobject[]optional

at most 3 items

2 child attributes

srcstringoptional: up to 2,048 characters
altstringoptional: up to 100,000 characters

BoxedBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"boxed"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

QuoteBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"quote"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

text2stringoptional

up to 100,000 characters

ListBlockInput

7 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"list"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

ProductBlockInput

13 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"product"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

weightstringoptional

The name and price in bold (the default) or regular weight.

one of regular, bold

textstringoptional

up to 100,000 characters

text2stringoptional

up to 100,000 characters

descstringoptional

up to 100,000 characters

hrefstringoptional

up to 2,048 characters

srcstringoptional

up to 2,048 characters

altstringoptional

up to 100,000 characters

VideoBlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"video"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

srcstringoptional

up to 2,048 characters

altstringoptional

up to 100,000 characters

textstringoptional

up to 100,000 characters

hrefstringoptional

up to 2,048 characters

SocialBlockInput

10 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"social"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

linksobject[]optional

The profiles to show; without any, the brand kit's social links.

at most 10 items

2 child attributes

labelstringrequired: 1–80 characters
hrefstringrequired: uri · pattern ^[^\s{}]*$ · up to 2,048 characters

displaystringoptional

Each link as its network's icon (the default), the icon and its label, or the label alone. The network is read from the link's address; any other address shows a globe.

one of icons, both, text

iconStylestringoptional

Icons in each network's colour (the default), near-black, or white for a dark background.

one of color, dark, light

MenuBlockInput

9 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"menu"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

linksobject[]optional

The entries, left to right: at most 8 { label, href }.

at most 8 items

2 child attributes

labelstringrequired: 1–80 characters
hrefstringrequired: uri · pattern ^[^\s{}]*$ · up to 2,048 characters

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

separatorstringoptional

What stands between entries: space only, a bar or a dot.

one of none, bar, dot

HtmlBlockInput

7 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"html"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

textstringoptional

up to 100,000 characters

SectionBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"section"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

backgroundImagestringoptional

A photo behind the section's blocks, covering the box. Needs style.backgroundColor, which Outlook for Windows and clients with images off show instead, and which text is made readable on.

pattern ^https:\/\/[^\s"'()<>\\{}]+$ · up to 2,048 characters

blocksobject[]required

The section's child blocks, drawn inside its box.

at least 1 item · at most 200 items

FooterBlockInput

8 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"footer"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

textstringoptional

up to 100,000 characters

lockedtrueoptional

alignstringoptional

When unset, headings, text, buttons and boxed text start from the reading side (left, or right in a right-to-left language); other blocks centre.

one of left, center, right

unsubscribeLinkbooleanoptional

False leaves out the unsubscribe link, for a transactional email (a receipt, a sign-in code). A marketing send adds the sender's own link anyway.

unsubscribeLabelstringoptional

The words of the unsubscribe link, "Unsubscribe" by default. The link opens a page that also manages topic preferences, so "Unsubscribe or manage preferences" is accurate.

up to 80 characters

RepeatBlockInput

9 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"repeat"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfobjectoptional

Show the block only to contacts these segment rules match, checked as each message is rendered. Omit to show it to everyone.

Any of 2 shapes

Match all
Match any

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

liststringrequired

The list to repeat over: event.properties.<name> (a journey's event, or a transactional send's data) or contact.attributes.<name>.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

limitintegeroptional

min 1 · max 100

blocksobject[]required

The blocks written out once per item of list, where {{ item.<field> }} reads that item. Repeats do not nest.

at least 1 item · at most 200 items

SharedBlockReferenceInput

7 child attributes

idstringrequired

Identifies the block within the template; unique among its blocks.

1–128 characters

type"shared"required

styleEmailBlockStyleInputoptional

Visual overrides for this block, such as colours, font and spacing.

19 child attributes

backgroundColorstringoptional

Fill behind the block.

fontFamilystringoptional

fontSizeintegeroptional

Text size in px, 12 to 72.

min 12 · max 72

mobileFontSizeintegeroptional

Text size in px on phones (screens up to 620px), 12 to 72. Email apps that ignore mobile styles use fontSize.

min 12 · max 72

paddingobjectoptional

Space inside the block in px, 0 to 100 per side; omitted sides keep their default.

mobilePaddingobjectoptional

Space inside the block in px on phones (screens up to 620px), 0 to 100 per side; omitted sides keep the block's padding (or its default). Email apps that ignore mobile styles use padding.

borderWidthintegeroptional

Border thickness in px; 0 for none.

min 0 · max 10

borderStylestringoptional

Border line style.

one of solid, dashed, dotted

borderColorstringoptional

Border colour.

borderRadiusintegeroptional

Corner rounding in px, 0 to 100.

min 0 · max 100

textColorstringoptional

Text colour.

linkColorstringoptional

Colour of links in the text.

linkUnderlinebooleanoptional

Set to false for links without an underline, such as a row of rating numbers or stars.

letterSpacingnumberoptional

Space between letters in px, such as 3 for a spaced-out eyebrow line.

min -2 · max 20

textTransformstringoptional

Set to uppercase to capitalise all text.

one of none, uppercase

lineHeightnumberoptional

A multiple of the font size.

min 1 · max 3

fontWeightstringoptional

Text weight.

one of regular, bold

fontStylestringoptional

Text style.

one of normal, italic

insetbooleanoptional

Draw the background and border as a box within the content width, not across the whole row.

visibleIfPresentstringoptional

Show the block only when this value is present (not missing, empty or false), such as data.vat for a VAT row; checked as each message is rendered.

pattern ^(?:contact\.attributes\.[\p{L}\p{N}\p{M}_.-]{1,64}|(?:event\.properties|data)\.[A-Za-z0-9_.-]+)$

showOnstringoptional

Show the block only on phones (screens up to 620px) or only on wider screens. Clients that ignore screen size show the desktop version, and so does plain text. Omit to show it everywhere.

one of mobile, desktop

sharedBlockIdstringrequired

The workspace's shared block placed here, by reference.

uuid

overrideobject[]optional

Edited here only: these blocks render instead of the shared content. Omit to follow the shared block.

at least 1 item · at most 200 items

themeEmailThemeInputoptional

Theme values this email overrides. Defaults to {}, which keeps the workspace brand kit.

14 child attributes

bodyFontFamilystringoptional

Body font stack, such as Inter, sans-serif.

pattern ^[\w\s,'"-]+$ · up to 200 characters

headingFontFamilystringoptional

Heading font stack.

pattern ^[\w\s,'"-]+$ · up to 200 characters

cardBackgroundColorstringoptional

Background of the email card, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

canvasBackgroundColorstringoptional

Background behind the card, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

textColorstringoptional

Default text colour, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

accentColorstringoptional

Brand colour for buttons and highlights, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

linkColorstringoptional

Link colour, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

headingColorstringoptional

Heading colour, as hex; unset, headings take textColor.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

buttonTextColorstringoptional

Label colour of solid buttons in accentColor, as hex; unset, white or near-black, whichever reads on it.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

baseFontSizestringoptional

Body text size; headings and buttons scale with it. Unset is 16px.

one of 14px, 15px, 16px, 17px, 18px

cardWidthstringoptional

Width of the email card on wide screens.

one of 560px, 600px, 680px

cardBorderRadiusstringoptional

Corner rounding of the email's card.

one of 0px, 6px, 12px, 16px, 24px, 999px

buttonBorderRadiusstringoptional

Button corners; cardBorderRadius rounds the email's card and, when this is unset, buttons.

one of 0px, 6px, 12px, 16px, 24px, 999px

buttonStylestringoptional

Button style.

one of solid, outline

languagestringoptional

The language the email is written in, as a BCP 47 tag ("en", "fr-BE", "ar"). It sets the HTML lang and the reading direction: Arabic, Hebrew, Persian, Urdu and other right-to-left languages render right to left. Defaults to "en".

up to 35 characters

plainTextOverridestring | nulloptional

Plain text used instead of the version generated from the design or HTML.

up to 100,000 characters

contactobjectoptional

A contact whose values fill the merge tags and decide each block's visibleIf. Without one, merge tags show their defaults.

Any of 3 shapes

By contact id

1 child attribute

contactIdstringrequired

Kirora's id for the contact.

uuid

By external id

1 child attribute

externalIdstringrequired

Your own id for the contact, as set with identify.

1–255 characters

By email

1 child attribute

emailstringrequired: The contact's email address, matched trimmed and without case.

subjectstringrequired

The subject line.

1–998 characters

datamap<string, any>optional

Sample data for {{ event.properties.* }} tags and repeat lists: what a transactional send's data or a journey's event would carry. Without it, a repeat shows once with its item tags as written.

keys: pattern ^[A-Za-z0-9_-]{1,64}$

fromstringoptional

The address the test comes from, on one of the workspace's verified domains; the workspace's default sender when omitted.

email · up to 320 characters

tostringrequired

Where to send the test: any member of the workspace who has accepted their invitation.

email · up to 320 characters

SendHtmlTemplateTestInput

9 child attributes

kind"html"required

html: the whole email written as HTML, kept as code.

htmlstringrequired

The whole email as HTML. Merge tags work as in a design; {{unsubscribe_url}} as a link's href places the unsubscribe link, which marketing sends otherwise get below the email, with the workspace postal address when the email does not show it.

up to 512,000 characters

contextstringoptional

HTML only. marketing: the email as a marketing send has it, with the postal address and an unsubscribe link ({{unsubscribe_url}}; # in a test send) added below when the HTML does not show them. transactional (the default): nothing is added, as a transactional send adds nothing, and the HTML is as saving keeps it.

one of marketing, transactional · default "transactional"

plainTextOverridestring | nulloptional

Plain text used instead of the version generated from the design or HTML.

up to 100,000 characters

contactobjectoptional

A contact whose values fill the merge tags and decide each block's visibleIf. Without one, merge tags show their defaults.

Any of 3 shapes

By contact id

1 child attribute

contactIdstringrequired

Kirora's id for the contact.

uuid

By external id

1 child attribute

externalIdstringrequired

Your own id for the contact, as set with identify.

1–255 characters

By email

1 child attribute

emailstringrequired: The contact's email address, matched trimmed and without case.

subjectstringrequired

The subject line.

1–998 characters

datamap<string, any>optional

Sample data for {{ event.properties.* }} tags and repeat lists: what a transactional send's data or a journey's event would carry. Without it, a repeat shows once with its item tags as written.

keys: pattern ^[A-Za-z0-9_-]{1,64}$

fromstringoptional

The address the test comes from, on one of the workspace's verified domains; the workspace's default sender when omitted.

email · up to 320 characters

tostringrequired

Where to send the test: any member of the workspace who has accepted their invitation.

email · up to 320 characters

Returns

Returns 200 OK with a TemplateTestSend in data. It can also return 409 Conflict, 413 Payload Too Large or 415 Unsupported Media Type; see the statuses below. Otherwise returns an error; Errors lists every code and which to retry.

200 OKThe test was handed to the email provider: the address it came from and its id.
409 ConflictThe request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.
413 Payload Too LargeThe body is larger than this operation accepts (PAYLOAD_TOO_LARGE).
415 Unsupported Media TypeThe body is not JSON, or not the upload the operation takes (UNSUPPORTED_MEDIA_TYPE).

fromstringrequired: The address it came from.
providerMessageIdstringrequired: The email provider's id for the test message.

Headers on `200 OK`

Idempotency-Replaystringoptional

true when this is the stored response to an earlier request with the same key.

one of true

curl -X POST https://api.kirora.io/v1/templates/test-send \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Idempotency-Key: sendTemplateTest-0001" \
  -H "Content-Type: application/json" \
  -d '{
    "blocks": [
      {
        "id": "title",
        "type": "heading",
        "text": "Welcome to Acme Shop",
        "size": "28px"
      },
      {
        "id": "intro",
        "type": "text",
        "text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free."
      },
      {
        "id": "shop",
        "type": "button",
        "text": "Start shopping",
        "href": "https://acme-shop.com"
      },
      {
        "id": "store-footer",
        "type": "shared",
        "sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b"
      },
      {
        "id": "footer",
        "type": "footer",
        "text": "{{ org.name }}\n{{ org.address }}",
        "locked": true
      }
    ],
    "theme": {
      "bodyFontFamily": "Arial, sans-serif",
      "headingFontFamily": "Georgia, serif",
      "cardBackgroundColor": "#ffffff",
      "canvasBackgroundColor": "#f4f1ec",
      "textColor": "#1f2933",
      "accentColor": "#b4461f",
      "linkColor": "#b4461f",
      "cardWidth": "600px",
      "cardBorderRadius": "6px",
      "buttonStyle": "solid"
    },
    "contact": {
      "contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d"
    },
    "subject": "Welcome to Acme Shop",
    "to": "[email protected]"
  }'

const response = await fetch('https://api.kirora.io/v1/templates/test-send', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Idempotency-Key': "sendTemplateTest-0001",
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "blocks": [
      {
        "id": "title",
        "type": "heading",
        "text": "Welcome to Acme Shop",
        "size": "28px"
      },
      {
        "id": "intro",
        "type": "text",
        "text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free."
      },
      {
        "id": "shop",
        "type": "button",
        "text": "Start shopping",
        "href": "https://acme-shop.com"
      },
      {
        "id": "store-footer",
        "type": "shared",
        "sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b"
      },
      {
        "id": "footer",
        "type": "footer",
        "text": "{{ org.name }}\n{{ org.address }}",
        "locked": true
      }
    ],
    "theme": {
      "bodyFontFamily": "Arial, sans-serif",
      "headingFontFamily": "Georgia, serif",
      "cardBackgroundColor": "#ffffff",
      "canvasBackgroundColor": "#f4f1ec",
      "textColor": "#1f2933",
      "accentColor": "#b4461f",
      "linkColor": "#b4461f",
      "cardWidth": "600px",
      "cardBorderRadius": "6px",
      "buttonStyle": "solid"
    },
    "contact": {
      "contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d"
    },
    "subject": "Welcome to Acme Shop",
    "to": "[email protected]"
  }),
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/templates/test-send",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
        "Idempotency-Key": "sendTemplateTest-0001",
    },
    json={
        "blocks": [
            {
                "id": "title",
                "type": "heading",
                "text": "Welcome to Acme Shop",
                "size": "28px",
            },
            {
                "id": "intro",
                "type": "text",
                "text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free.",
            },
            {
                "id": "shop",
                "type": "button",
                "text": "Start shopping",
                "href": "https://acme-shop.com",
            },
            {
                "id": "store-footer",
                "type": "shared",
                "sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b",
            },
            {
                "id": "footer",
                "type": "footer",
                "text": "{{ org.name }}\n{{ org.address }}",
                "locked": True,
            },
        ],
        "theme": {
            "bodyFontFamily": "Arial, sans-serif",
            "headingFontFamily": "Georgia, serif",
            "cardBackgroundColor": "#ffffff",
            "canvasBackgroundColor": "#f4f1ec",
            "textColor": "#1f2933",
            "accentColor": "#b4461f",
            "linkColor": "#b4461f",
            "cardWidth": "600px",
            "cardBorderRadius": "6px",
            "buttonStyle": "solid",
        },
        "contact": {
            "contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d",
        },
        "subject": "Welcome to Acme Shop",
        "to": "[email protected]",
    },
)
response.raise_for_status()
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "blocks": [
	    {
	      "id": "title",
	      "type": "heading",
	      "text": "Welcome to Acme Shop",
	      "size": "28px"
	    },
	    {
	      "id": "intro",
	      "type": "text",
	      "text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free."
	    },
	    {
	      "id": "shop",
	      "type": "button",
	      "text": "Start shopping",
	      "href": "https://acme-shop.com"
	    },
	    {
	      "id": "store-footer",
	      "type": "shared",
	      "sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b"
	    },
	    {
	      "id": "footer",
	      "type": "footer",
	      "text": "{{ org.name }}\n{{ org.address }}",
	      "locked": true
	    }
	  ],
	  "theme": {
	    "bodyFontFamily": "Arial, sans-serif",
	    "headingFontFamily": "Georgia, serif",
	    "cardBackgroundColor": "#ffffff",
	    "canvasBackgroundColor": "#f4f1ec",
	    "textColor": "#1f2933",
	    "accentColor": "#b4461f",
	    "linkColor": "#b4461f",
	    "cardWidth": "600px",
	    "cardBorderRadius": "6px",
	    "buttonStyle": "solid"
	  },
	  "contact": {
	    "contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d"
	  },
	  "subject": "Welcome to Acme Shop",
	  "to": "[email protected]"
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/templates/test-send", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Idempotency-Key", "sendTemplateTest-0001")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.kirora.io/v1/templates/test-send");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));
request.Headers.Add("Idempotency-Key", "sendTemplateTest-0001");
request.Content = new StringContent(
    """
    {
      "blocks": [
        {
          "id": "title",
          "type": "heading",
          "text": "Welcome to Acme Shop",
          "size": "28px"
        },
        {
          "id": "intro",
          "type": "text",
          "text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free."
        },
        {
          "id": "shop",
          "type": "button",
          "text": "Start shopping",
          "href": "https://acme-shop.com"
        },
        {
          "id": "store-footer",
          "type": "shared",
          "sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b"
        },
        {
          "id": "footer",
          "type": "footer",
          "text": "{{ org.name }}\n{{ org.address }}",
          "locked": true
        }
      ],
      "theme": {
        "bodyFontFamily": "Arial, sans-serif",
        "headingFontFamily": "Georgia, serif",
        "cardBackgroundColor": "#ffffff",
        "canvasBackgroundColor": "#f4f1ec",
        "textColor": "#1f2933",
        "accentColor": "#b4461f",
        "linkColor": "#b4461f",
        "cardWidth": "600px",
        "cardBorderRadius": "6px",
        "buttonStyle": "solid"
      },
      "contact": {
        "contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d"
      },
      "subject": "Welcome to Acme Shop",
      "to": "[email protected]"
    }
    """,
    Encoding.UTF8,
    "application/json");

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");

using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var data = document.RootElement.GetProperty("data");

Response · 200

{
  "data": {
    "providerMessageId": "0100019a-2b3c-4d5e-8f60-7a8b9c0d1e2f-000000",
    "from": "Acme Shop <[email protected]>"
  }
}

Send a test email

Header parameters

Request body

Returns

Headers on 200 OK

Headers on `200 OK`