Run the template's checks on the draft or the editor's unsaved content

POST

/api/v1/workspaces/{workspace}/transactional/templates/{template}/checks

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/templates/password-reset/checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "editorMode": "visual", "html": "example", "mjml": "example", "plainText": "example", "preheader": "example", "subject": "example", "testData": [ { "data": { "additionalProperty": "example" }, "name": "New user" } ], "trackClicks": true, "trackOpens": true, "variables": [ { "default": "example", "description": "example", "name": "reset_url", "required": true, "sample": "example", "sensitive": true, "type": "text" } ] }'

• Your ReputeCast public URL

Permission: transactional:view

The composer’s content checks (size, alt text, links, plain text; unsubscribe link and footer address for Optional categories) and the transactional ones: Liquid errors, undeclared and unused variables, test data that fails to render, a sensitive variable in the subject, tracking on an Essential template.

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

template

required

The template’s ID, such as password-reset, or its UUID

string

<= 64 characters

The template’s ID, such as password-reset, or its UUID

Request Body^required

Media typeapplication/json

object

editorMode

string

Allowed values: visual mjml html

html

string

<= 2500000 characters

mjml

string

<= 2000000 characters

plainText

string

<= 500000 characters

preheader

string

<= 500 characters

subject

string

<= 998 characters

testData

Array<object>

<= 50 items

object

data

required

object

key

additional properties

name

required

string

>= 1 characters <= 80 characters

trackClicks

boolean

trackOpens

boolean

variables

Array<object>

<= 200 items

object

default

string

<= 4000 characters

description

string

<= 300 characters

name

required

string

>= 1 characters <= 64 characters /^[A-Za-z_][A-Za-z0-9_]*$/

required

required

boolean

sample

string

<= 4000 characters

sensitive

required

Never stored: logs and stored content show ••••••

boolean

type

required

string

Allowed values: text number boolean date url list object

Responses

200

OK

Media typeapplication/json

object

blocks

required

integer format: int64

checks

required

Array<object>

object

detail

string

fixes

required

Array<object>

object

kind

required

string

Allowed values: declare_variable remove_variable make_optional add_test_value insert_footer set_alt minify edit_link replace_link move_to_body turn_off_tracking

label

required

string

path

Array<integer>

testData

string

value

string

variable

string

group

required

string

Allowed values: Content Links Compliance Subject Variables Test data Privacy Accessibility

id

required

string

line

integer format: int64

path

required

Array<integer>

severity

required

string

Allowed values: block warn info pass

testData

string

title

required

string

variable

string

where

string

Allowed values: subject preheader body text

clipBytes

required

integer format: int64

images

required

integer format: int64

links

required

integer format: int64

passed

required

integer format: int64

plainText

required

string

sizeBytes

required

integer format: int64

testData

required

Array<object>

object

at

string

defaults

required

Array<string>

missing

required

Array<string>

name

required

string

ok

required

boolean

problem

string

recipient

string

source

required

string

Allowed values: test_data last_call

subject

string

variables

required

object

undeclared

required

Array<object>

object

column

required

integer format: int64

line

required

integer format: int64

name

required

string

where

required

string

Allowed values: subject preheader body text

unused

required

Array<string>

used

required

Array<object>

object

column

required

integer format: int64

line

required

integer format: int64

name

required

string

where

required

string

Allowed values: subject preheader body text

verdict

required

string

Allowed values: ready warnings blocked

warnings

required

integer format: int64

Example

{
  "checks": [
    {
      "fixes": [
        {
          "kind": "declare_variable"
        }
      ],
      "group": "Content",
      "id": "variables.undeclared",
      "severity": "block",
      "where": "subject"
    }
  ],
  "testData": [
    {
      "source": "test_data"
    }
  ],
  "variables": {
    "undeclared": [
      {
        "where": "subject"
      }
    ],
    "used": [
      {
        "where": "subject"
      }
    ]
  },
  "verdict": "ready"
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}