Skip to main content
PATCH
Change a template

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The template's ID (not its key).

Body

application/json

Send only what changes. The key cannot be changed.

name
string | null

Null or blank clears it. Cut to 120 characters.

subject_template
string

Cannot be empty.

Minimum string length: 1
body_template
string

Cannot be empty. Sending this without body_template_blocks turns a document back into plain text.

body_template_blocks
object[]

A message written as a document: at most 200 blocks.

One block of a document. An unknown type is refused.

variables
any[]

Replaces the list whole.

metadata
object

Merged into what is kept: a key you send replaces that key, and the others stay.

status
enum<string>
Available options:
active,
draft,
archived
note
string

Why the wording changed, kept on the version this change records.

Response

The template, as it now is.

id
string
required
key
string
required

What a send names the template by. It cannot be changed.

channel
enum<string>
required

Always email.

Available options:
email
subject_template
string
required

The subject, with any {{merge_fields}}.

body_template
string
required

The body as plain text, with any {{merge_fields}}. When the template is written as a document, this is the document's text.

status
enum<string>
required

Only an active template can be sent or filled.

Available options:
active,
draft,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required
tenant_id
string

Your organization's ID.

name
string | null

The name people read. Null means the key stands in for it.

body_template_blocks
object[] | null

The body as a document, or null for a template written as plain text.

One block of a document. An unknown type is refused.

variables
any[]

A list kept with the template, as you last sent it.

metadata
object

Anything else you keep with the template.