Templates

Get all template categories for the current user

GET/v1/templates/categories

PERF: Limited to 100 categories with AsNoTracking for read-only query. PERF FIX: Uses two queries + in-memory merge instead of N+1 subqueries.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/templates/categories"

curl -X GET "https://example.com/v1/templates/categories"

{
  "categories": [
    {
      "id": "string",
      "name": "string",
      "description": null,
      "color": null,
      "templateCount": 0,
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalCount": 0
}

{  "categories": [    {      "id": "string",      "name": "string",      "description": null,      "color": null,      "templateCount": 0,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "totalCount": 0}

Create a new template category

POST/v1/templates/categories

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/templates/categories"

curl -X POST "https://example.com/v1/templates/categories"

{
  "id": "string",
  "name": "string",
  "description": null,
  "color": null,
  "templateCount": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "description": null,  "color": null,  "templateCount": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Get a specific template category

GET/v1/templates/categories/{id}

PERF FIX: Uses two simple queries instead of subquery in projection.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/templates/categories/string"

curl -X GET "https://example.com/v1/templates/categories/string"

{
  "id": "string",
  "name": "string",
  "description": null,
  "color": null,
  "templateCount": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "description": null,  "color": null,  "templateCount": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Update a template category

PUT/v1/templates/categories/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/templates/categories/string"

curl -X PUT "https://example.com/v1/templates/categories/string"

{
  "id": "string",
  "name": "string",
  "description": null,
  "color": null,
  "templateCount": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "description": null,  "color": null,  "templateCount": 0,  "createdAt": "2019-08-24T14:15:22Z"}

Delete a template category (templates in this category will have their category set to null)

DELETE/v1/templates/categories/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/templates/categories/string"

curl -X DELETE "https://example.com/v1/templates/categories/string"

Empty

Get templates for the current user with pagination, optionally filtered by category

GET/v1/templates

PERF: Paginated to prevent loading all templates into memory.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

categoryId?string

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

cursor?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/templates"

curl -X GET "https://example.com/v1/templates"

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "subject": "string",
      "htmlContent": "string",
      "textContent": null,
      "categoryId": null,
      "categoryName": null,
      "categoryColor": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": null,
      "grammarVersion": "string",
      "variableDefaults": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "name": "string",      "subject": "string",      "htmlContent": "string",      "textContent": null,      "categoryId": null,      "categoryName": null,      "categoryColor": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": null,      "grammarVersion": "string",      "variableDefaults": {        "property1": "string",        "property2": "string"      }    }  ],  "nextCursor": null,  "hasMore": true}

/v1/templates

POST/v1/templates

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/templates"

curl -X POST "https://example.com/v1/templates"

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "htmlContent": "string",
  "textContent": null,
  "categoryId": null,
  "categoryName": null,
  "categoryColor": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": null,
  "grammarVersion": "string",
  "variableDefaults": {
    "property1": "string",
    "property2": "string"
  }
}

{  "id": "string",  "name": "string",  "subject": "string",  "htmlContent": "string",  "textContent": null,  "categoryId": null,  "categoryName": null,  "categoryColor": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": null,  "grammarVersion": "string",  "variableDefaults": {    "property1": "string",    "property2": "string"  }}

/v1/templates/{id}

GET/v1/templates/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/templates/string"

curl -X GET "https://example.com/v1/templates/string"

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "htmlContent": "string",
  "textContent": null,
  "categoryId": null,
  "categoryName": null,
  "categoryColor": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": null,
  "grammarVersion": "string",
  "variableDefaults": {
    "property1": "string",
    "property2": "string"
  }
}

{  "id": "string",  "name": "string",  "subject": "string",  "htmlContent": "string",  "textContent": null,  "categoryId": null,  "categoryName": null,  "categoryColor": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": null,  "grammarVersion": "string",  "variableDefaults": {    "property1": "string",    "property2": "string"  }}

/v1/templates/{id}

PUT/v1/templates/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/templates/string"

curl -X PUT "https://example.com/v1/templates/string"

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "htmlContent": "string",
  "textContent": null,
  "categoryId": null,
  "categoryName": null,
  "categoryColor": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": null,
  "grammarVersion": "string",
  "variableDefaults": {
    "property1": "string",
    "property2": "string"
  }
}

{  "id": "string",  "name": "string",  "subject": "string",  "htmlContent": "string",  "textContent": null,  "categoryId": null,  "categoryName": null,  "categoryColor": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": null,  "grammarVersion": "string",  "variableDefaults": {    "property1": "string",    "property2": "string"  }}

/v1/templates/{id}

DELETE/v1/templates/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/templates/string"

curl -X DELETE "https://example.com/v1/templates/string"

Empty

/v1/templates/{id}/duplicate

POST/v1/templates/{id}/duplicate

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/templates/string/duplicate"

curl -X POST "https://example.com/v1/templates/string/duplicate"

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "htmlContent": "string",
  "textContent": null,
  "categoryId": null,
  "categoryName": null,
  "categoryColor": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": null,
  "grammarVersion": "string",
  "variableDefaults": {
    "property1": "string",
    "property2": "string"
  }
}

{  "id": "string",  "name": "string",  "subject": "string",  "htmlContent": "string",  "textContent": null,  "categoryId": null,  "categoryName": null,  "categoryColor": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": null,  "grammarVersion": "string",  "variableDefaults": {    "property1": "string",    "property2": "string"  }}

Get rendered preview of a template with sample values for variables.

GET/v1/templates/{id}/preview

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Template public ID

Response Body

`application/json`

curl -X GET "https://example.com/v1/templates/string/preview"

curl -X GET "https://example.com/v1/templates/string/preview"

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "renderedHtml": null,
  "renderedText": null
}

{  "id": "string",  "name": "string",  "subject": "string",  "renderedHtml": null,  "renderedText": null}

Templates

Get all template categories for the current userCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

Create a new template categoryCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Request BodyCopiar enlace de la sección

Response BodyCopiar enlace de la sección

201application/json

400application/json

409application/json

Get a specific template categoryCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

404application/json

Update a template categoryCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Request BodyCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

400application/json

404application/json

409application/json

Delete a template category (templates in this category will have their category set to null)Copiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

204

404application/json

Get templates for the current user with pagination, optionally filtered by categoryCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Query ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

400application/json

/v1/templatesCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Request BodyCopiar enlace de la sección

Response BodyCopiar enlace de la sección

201application/json

400application/json

409application/json

/v1/templates/{id}Copiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

404application/json

/v1/templates/{id}Copiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Request BodyCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

400application/json

404application/json

/v1/templates/{id}Copiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

204

404application/json

/v1/templates/{id}/duplicateCopiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

201application/json

404application/json

500

Get rendered preview of a template with sample values for variables.Copiar enlace de la sección

AuthorizationCopiar enlace de la sección

Path ParametersCopiar enlace de la sección

Response BodyCopiar enlace de la sección

200application/json

404application/json

Get all template categories for the current user

Authorization

Response Body

`application/json`

Create a new template category

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Get a specific template category

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update a template category

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Delete a template category (templates in this category will have their category set to null)

Authorization

Path Parameters

Response Body

`application/json`

Get templates for the current user with pagination, optionally filtered by category

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

/v1/templates

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

/v1/templates/{id}

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

/v1/templates/{id}

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

/v1/templates/{id}

Authorization

Path Parameters

Response Body

`application/json`

/v1/templates/{id}/duplicate

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Get rendered preview of a template with sample values for variables.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`