Templates API

10 operations. Guide: Build emails from templates. Requests and responses are JSON with snake_case fields; authenticate with Authorization: Bearer <api key>. The examples assume a client built as in SDKs and the command line.

Create a hosted template

POST /v1/templates

Block documents are rendered by the platform; html accepts pre-rendered markup (React Email compiled by the CLI) with {{variables}}. The platform never executes caller code.

Operation createTemplate, SDK minket.templates.create. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Request body

Field	Type	Required	Description
`name`	string	yes	1 to 100 characters.
`alias`	string or null	no	At most 100 characters.
`subject`	string or null	no	At most 998 characters.
`from`	string or null	no	An email address, optionally with a display name as `Name <address>`. 3 to 998 characters.
`reply_to`	string or array of string	no	One address, or an array of up to 50.
`document`	object	no
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string	no	At most 1048576 characters.
`text`	string	no
`variables`	array of object	no	At most 100 items.
`variables[].key`	string	yes	1 to 64 characters.
`variables[].type`	one of "string", "number", "boolean"	yes
`variables[].fallback_value`	string or number or boolean or null	yes
`variables[].required`	boolean	no
`publish`	boolean	no	Default `false`.

Response

201 Created: Template.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"template"	yes
`project_id`	string	yes	A UUID.
`name`	string	yes
`alias`	string or null	yes
`status`	one of "draft", "published"	yes
`engine`	one of "blocks", "html"	yes
`current_version`	integer	yes
`published_version`	integer or null	yes
`subject`	string or null	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`variables`	array of object	yes
`variables[].key`	string	yes	1 to 64 characters.
`variables[].type`	one of "string", "number", "boolean"	yes
`variables[].fallback_value`	string or number or boolean or null	yes
`variables[].required`	boolean	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/templates \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Receipt","alias":"receipt","subject":"Your receipt for order {{order}}","html":"<p>Thanks for order {{order}}.</p>","publish":true}'

TypeScript

const result = await minket.templates.create({
  name: "Receipt",
  alias: "receipt",
  subject: "Your receipt for order {{order}}",
  html: "<p>Thanks for order {{order}}.</p>",
  publish: true
});

CLI

minket api createTemplate --body '{"name":"Receipt","alias":"receipt","subject":"Your receipt for order {{order}}","html":"<p>Thanks for order {{order}}.</p>","publish":true}'

Python

from minket.api.templates import create_template
from minket.models import CreateTemplateBody

result = create_template.sync(client=client, body=CreateTemplateBody.from_dict({"name":"Receipt","alias":"receipt","subject":"Your receipt for order {{order}}","html":"<p>Thanks for order {{order}}.</p>","publish":true}))

var body minket.CreateTemplateJSONRequestBody
res, err := client.CreateTemplateWithResponse(ctx, body)

List templates

GET /v1/templates

Operation listTemplates, SDK minket.templates.list. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"template"	yes
`data[].project_id`	string	yes	A UUID.
`data[].name`	string	yes
`data[].alias`	string or null	yes
`data[].status`	one of "draft", "published"	yes
`data[].engine`	one of "blocks", "html"	yes
`data[].current_version`	integer	yes
`data[].published_version`	integer or null	yes
`data[].subject`	string or null	yes
`data[].from`	string or null	yes
`data[].reply_to`	array of string	yes
`data[].variables`	array of object	yes
`data[].variables[].key`	string	yes	1 to 64 characters.
`data[].variables[].type`	one of "string", "number", "boolean"	yes
`data[].variables[].fallback_value`	string or number or boolean or null	yes
`data[].variables[].required`	boolean	yes
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/templates \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.list();

CLI

minket api listTemplates

Python

from minket.api.templates import list_templates

result = list_templates.sync(client=client)

res, err := client.ListTemplatesWithResponse(ctx, &minket.ListTemplatesParams{})

Get a template (by id or alias)

GET /v1/templates/{id}

Operation getTemplate, SDK minket.templates.get. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Response

200 Success: Template.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"template"	yes
`project_id`	string	yes	A UUID.
`name`	string	yes
`alias`	string or null	yes
`status`	one of "draft", "published"	yes
`engine`	one of "blocks", "html"	yes
`current_version`	integer	yes
`published_version`	integer or null	yes
`subject`	string or null	yes
`from`	string or null	yes
`reply_to`	array of string	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`variables`	array of object	yes
`variables[].key`	string	yes	1 to 64 characters.
`variables[].type`	one of "string", "number", "boolean"	yes
`variables[].fallback_value`	string or number or boolean or null	yes
`variables[].required`	boolean	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.get("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.templates import get_template

result = get_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Update a template (creates a new draft version)

PATCH /v1/templates/{id}

Operation updateTemplate, SDK minket.templates.update. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Request body

Field	Type	Required	Description
`name`	string	no	1 to 100 characters.
`alias`	string or null	no	At most 100 characters.
`subject`	string or null	no	At most 998 characters.
`from`	string or null	no	An email address, optionally with a display name as `Name <address>`. 3 to 998 characters.
`reply_to`	string or array of string	no	One address, or an array of up to 50.
`document`	object	no
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string	no	At most 1048576 characters.
`text`	string	no
`variables`	array of object	no	At most 100 items.
`variables[].key`	string	yes	1 to 64 characters.
`variables[].type`	one of "string", "number", "boolean"	yes
`variables[].fallback_value`	string or number or boolean or null	yes
`variables[].required`	boolean	no
`publish`	boolean	no	Default `false`.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"template"	yes
`id`	string	yes	A UUID.
`current_version`	integer	yes
`published_version`	integer or null	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X PATCH https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"Receipt for order {{order}}"}'

TypeScript

const result = await minket.templates.update("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  subject: "Receipt for order {{order}}"
});

CLI

minket api updateTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"subject":"Receipt for order {{order}}"}'

Python

from minket.api.templates import update_template
from minket.models import UpdateTemplateBody

result = update_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=UpdateTemplateBody.from_dict({"subject":"Receipt for order {{order}}"}))

var body minket.UpdateTemplateJSONRequestBody
res, err := client.UpdateTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Delete a template

DELETE /v1/templates/{id}

Operation deleteTemplate, SDK minket.templates.delete. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Response

200 Success: object.

Field	Type	Required
`object`	"template"	yes
`id`	string	yes
`deleted`	true	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X DELETE https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.delete("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api deleteTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.templates import delete_template

result = delete_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DeleteTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Publish the current draft version

POST /v1/templates/{id}/publish

Operation publishTemplate, SDK minket.templates.publish. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Response

200 Success: object.

Field	Type	Required	Description
`object`	"template"	yes
`id`	string	yes	A UUID.
`current_version`	integer	yes
`published_version`	integer or null	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/publish \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.publish("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api publishTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.templates import publish_template

result = publish_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.PublishTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Duplicate a template

POST /v1/templates/{id}/duplicate

Operation duplicateTemplate, SDK minket.templates.duplicate. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Response

201 Created: object.

Field	Type	Required	Description
`object`	"template"	yes
`id`	string	yes	A UUID.
`current_version`	integer	yes
`published_version`	integer or null	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/duplicate \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.duplicate("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api duplicateTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.templates import duplicate_template

result = duplicate_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DuplicateTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

List a template's versions

GET /v1/templates/{id}/versions

Operation listTemplateVersions, SDK minket.templates.versions. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].version`	integer	yes
`data[].subject`	string or null	yes
`data[].document`	object or null	yes
`data[].document.version`	1	yes
`data[].document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`data[].document.settings.width`	integer	no	320 to 800. Default `600`.
`data[].document.settings.background`	string	no	Default `"#f4f4f5"`.
`data[].document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`data[].document.settings.footer`	string	no	At most 2000 characters.
`data[].document.blocks`	array of object	yes	At most 200 items.
`data[].document.blocks[] (shape 1).type`	"heading"	yes
`data[].document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`data[].document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`data[].document.blocks[] (shape 1).style`	object	no
`data[].document.blocks[] (shape 2).type`	"paragraph"	yes
`data[].document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`data[].document.blocks[] (shape 2).style`	object	no
`data[].document.blocks[] (shape 3).type`	"image"	yes
`data[].document.blocks[] (shape 3).src`	string	yes
`data[].document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`data[].document.blocks[] (shape 3).href`	string	no
`data[].document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`data[].document.blocks[] (shape 3).style`	object	no
`data[].document.blocks[] (shape 4).type`	"button"	yes
`data[].document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`data[].document.blocks[] (shape 4).href`	string	yes
`data[].document.blocks[] (shape 4).style`	object	no
`data[].document.blocks[] (shape 5).type`	"divider"	yes
`data[].document.blocks[] (shape 5).style`	object	no
`data[].document.blocks[] (shape 6).type`	"spacer"	yes
`data[].document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`data[].document.blocks[] (shape 7).type`	"html"	yes
`data[].document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`data[].document.blocks[] (shape 8).type`	"columns"	yes
`data[].document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`data[].document.blocks[] (shape 8).style`	object	no
`data[].html`	string or null	yes
`data[].text`	string or null	yes
`data[].variables`	array of object	yes
`data[].variables[].key`	string	yes	1 to 64 characters.
`data[].variables[].type`	one of "string", "number", "boolean"	yes
`data[].variables[].fallback_value`	string or number or boolean or null	yes
`data[].variables[].required`	boolean	yes
`data[].published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/versions \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.versions("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listTemplateVersions 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.templates import list_template_versions

result = list_template_versions.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListTemplateVersionsWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Get one version

GET /v1/templates/{id}/versions/{version}

Operation getTemplateVersion, SDK minket.templates.version. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes
`version`	path	integer	yes

Response

200 Success: object.

Field	Type	Required	Description
`version`	integer	yes
`subject`	string or null	yes
`document`	object or null	yes
`document.version`	1	yes
`document.settings`	object	no	Default `{"width":600,"background":"#f4f4f5","font":"system"}`.
`document.settings.width`	integer	no	320 to 800. Default `600`.
`document.settings.background`	string	no	Default `"#f4f4f5"`.
`document.settings.font`	one of "system", "serif", "mono"	no	Default `"system"`.
`document.settings.footer`	string	no	At most 2000 characters.
`document.blocks`	array of object	yes	At most 200 items.
`document.blocks[] (shape 1).type`	"heading"	yes
`document.blocks[] (shape 1).level`	one of "1", "2", "3"	no	Default `"1"`.
`document.blocks[] (shape 1).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 1).style`	object	no
`document.blocks[] (shape 1).style.color`	string	no
`document.blocks[] (shape 1).style.background`	string	no
`document.blocks[] (shape 1).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 1).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 2).type`	"paragraph"	yes
`document.blocks[] (shape 2).text`	string	yes	At most 20000 characters.
`document.blocks[] (shape 2).style`	object	no
`document.blocks[] (shape 2).style.color`	string	no
`document.blocks[] (shape 2).style.background`	string	no
`document.blocks[] (shape 2).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 2).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 3).type`	"image"	yes
`document.blocks[] (shape 3).src`	string	yes
`document.blocks[] (shape 3).alt`	string	yes	At most 500 characters.
`document.blocks[] (shape 3).href`	string	no
`document.blocks[] (shape 3).width`	integer	no	16 to 1200.
`document.blocks[] (shape 3).style`	object	no
`document.blocks[] (shape 3).style.color`	string	no
`document.blocks[] (shape 3).style.background`	string	no
`document.blocks[] (shape 3).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 3).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 4).type`	"button"	yes
`document.blocks[] (shape 4).label`	string	yes	1 to 200 characters.
`document.blocks[] (shape 4).href`	string	yes
`document.blocks[] (shape 4).style`	object	no
`document.blocks[] (shape 4).style.color`	string	no
`document.blocks[] (shape 4).style.background`	string	no
`document.blocks[] (shape 4).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 4).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 5).type`	"divider"	yes
`document.blocks[] (shape 5).style`	object	no
`document.blocks[] (shape 5).style.color`	string	no
`document.blocks[] (shape 5).style.background`	string	no
`document.blocks[] (shape 5).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 5).style.padding`	integer	no	0 to 80.
`document.blocks[] (shape 6).type`	"spacer"	yes
`document.blocks[] (shape 6).height`	integer	yes	4 to 200.
`document.blocks[] (shape 7).type`	"html"	yes
`document.blocks[] (shape 7).html`	string	yes	At most 200000 characters.
`document.blocks[] (shape 8).type`	"columns"	yes
`document.blocks[] (shape 8).columns`	array of object	yes	At most 3 items.
`document.blocks[] (shape 8).columns[].blocks`	array of object	yes	At most 20 items.
`document.blocks[] (shape 8).style`	object	no
`document.blocks[] (shape 8).style.color`	string	no
`document.blocks[] (shape 8).style.background`	string	no
`document.blocks[] (shape 8).style.align`	one of "left", "center", "right"	no
`document.blocks[] (shape 8).style.padding`	integer	no	0 to 80.
`html`	string or null	yes
`text`	string or null	yes
`variables`	array of object	yes
`variables[].key`	string	yes	1 to 64 characters.
`variables[].type`	one of "string", "number", "boolean"	yes
`variables[].fallback_value`	string or number or boolean or null	yes
`variables[].required`	boolean	yes
`published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/versions/1 \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.templates.version("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", 1);

CLI

minket api getTemplateVersion 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b 1

Python

from minket.api.templates import get_template_version

result = get_template_version.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", 1, client=client)

res, err := client.GetTemplateVersionWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", 1)

Render a template with variables

POST /v1/templates/{id}/preview

Operation previewTemplate, SDK minket.templates.preview. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes

Request body

Field	Type	Required	Description
`variables`	map of string or number or boolean or null	no
`version`	integer	no

Response

200 Success: object.

Field	Type	Required
`subject`	string	yes
`html`	string	yes
`text`	string	yes
`missing`	array of string	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/templates/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/preview \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"variables":{"order":"10452"}}'

TypeScript

const result = await minket.templates.preview("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  variables: {
    order: "10452"
  }
});

CLI

minket api previewTemplate 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"variables":{"order":"10452"}}'

Python

from minket.api.templates import preview_template
from minket.models import PreviewTemplateBody

result = preview_template.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=PreviewTemplateBody.from_dict({"variables":{"order":"10452"}}))

var body minket.PreviewTemplateJSONRequestBody
res, err := client.PreviewTemplateWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Updated 30 October 2026