Templates

Create a template

POST/v1/templatesrequires template:write

Requestcurl -X POST https://api.transmit.dev/v1/templates \
  -H "Authorization: Bearer tr_v2_…" \
  -H "Content-Type: application/json" \
  -d '{
       "friendly_name": "order-shipped",
       "name": "Order shipped",
       "subject": "Your order is on its way",
       "html": "<p>Hello {{name}}, tracking: {{tracking}}.</p>"
     }'

Body

FieldTypeNotes
friendly_name requiredstring1–100 characters. matches ^[a-z0-9][a-z0-9_-]*$
name requiredstring1–200 characters
subject requiredstring1–998 characters
htmlstringat least 1 characters
textstringat least 1 characters
variablesobject

Responses

StatusMeaning
201The created template
401The API key is missing, malformed, expired or revoked
403The API key lacks the template:write scope
422The request failed validation

Every response body is described in the OpenAPI spec, which this page is generated from.