Skip to content

mail_template_archive

Hide a template from listings and pickers.

Tool

mail_template_archive

Hide a template from listings and pickers.

Hide a template from listings and pickers. Sending by its id keeps working — this is not a delete

Behavior

HTTP
POST /mail/templates/:id/archive

Arguments

Name
Type
Required
Description
id
string
•
Template id to archive

Response

Field
Type
Always
Description
id
string
•
Template id
html
string
•
HTML body; may contain {{ variable }} placeholders
name
string
•
Human label for the template
text
string
•
Plaintext body; null when none was supplied
status
string
•
Lifecycle status: published once a revision has gone live
subject
string
•
Email subject; may contain {{ variable }} placeholders
createdAt
string
•
When the template was created (ISO 8601 UTC)
updatedAt
string
•
When the template was last modified (ISO 8601 UTC)
variables
array
•
Declared variables of this template (at most 20)
archivedAt
string
•
When the template was archived (ISO 8601 UTC); null while it is listed normally. Archiving never stops a send
draftRevision
integer
•
Revision number of the open, unpublished draft; null when there is none
currentRevision
integer
•
Revision number a send renders; null until the template is first published

Try it

Hide a template from listings and pickers.

When to use

Hide a template from listings and pickers. Sending by its id keeps working — this is not a delete

Example

Ask your agent something like this:

Hide a template from listings and pickers.

The agent will invoke mail_template_archive with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select