Update a template

PUT

/templates/{id}

const url = 'https://mail.teamander.com/v1/templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"subject_template":"Updated subject {{company}}"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://mail.teamander.com/v1/templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subject_template": "Updated subject {{company}}" }'

Partial update; each save creates a new template version.

Authorizations

bearerAuth

Parameters

Path Parameters

required

Resource identifier

string

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request Body

application/json

object

name

string

>= 1 characters <= 255 characters

subject_template

string

>= 1 characters

mjml_source

string

design_json

object

schema_version

required

integer

>= 1 <= 1

theme

object

backgroundColor

required

string

<= 64 characters

contentBackgroundColor

required

string

<= 64 characters

fontFamily

required

string

<= 200 characters

linkColor

required

string

<= 64 characters

width

required

string

<= 16 characters

blocks

required

Array

<= 200 items

One of:

object

required

string

>= 1 characters <= 64 characters

type

required

string

Allowed values: heading

text

required

string

<= 500 characters

level

required

Any of:

number

Allowed values: 1

align

required

string

Allowed values: left center right

color

string

<= 64 characters

html

string

text_body

string

variables

object

key

additional properties

string

Example

{
  "subject_template": "Updated subject {{company}}"
}

Responses

200

Updated

application/json

object

required

string

version

required

integer

status

required

string

Allowed values: updated

compiled_html

string

warnings

Array<string>

variables

object

key

additional properties

string

Example

{
  "id": "receipt",
  "version": 2,
  "status": "updated"
}

400

Validation failed

application/json

object

error

required

string

details

object

key

additional properties

nullable

Example

{
  "error": "Validation failed",
  "details": {}
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}