Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Message Templates

Create message template

Create a new message template in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the Create team message template endpoint instead.

Required scope: message_templates:write

post/message_templates

Request body

namestring required

Name of the message template

subjectstring

Subject of the message template.

bodystring required

Body of the message template. You can supply HTML with inline CSS to structure and style your template.

folder_idstring

ID of the message template folder to place this message template in

inbox_idsstring[]

The specific inboxes this template is available in. If unspecified or null, then it will be available in all inboxes. Array should be non-empty.

attachmentsstring[]

Binary data of attached files. Must use Content-Type: multipart/form-data if specified. See example. Max 25 MB.

Example request

{
  "name": "Out of Office",
  "subject": "Out of Office",
  "body": "<p>Sorry, I'm OOO until <span style=\"color: green;\">October 25th</span>.</p>\n"
}

Response

A message template

idstring required

Unique identifier of the message template

namestring required

Name of the message template

subjectstring nullable required

Subject of the message template

bodystring required

Body of the message template

is_available_for_all_inboxesboolean required

Whether or not the template is available in all inboxes.

inbox_idsstring[] nullable required

List of inboxes the template is available in. Null if there are no restrictions.

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/responses/rsp_16yc",
    "related": {
      "owner": "https://yourCompany.api.frontapp.com/teams/tim_s47",
      "parent_folder": "https://yourCompany.api.frontapp.com/message_template_folders/rsf_g2"
    }
  },
  "id": "rsp_16yc",
  "name": "Pam wedding planning complaint",
  "subject": "Work time being used for wedding planning",
  "body": "<div><p>Pam is spending time planning her <span style=\"color:red;\">wedding</span> at the office. This message <b>WAS NOT</b> sent by Angela.</p></div>\n",
  "attachments": [
    {
      "id": "fil_3q8a7mby",
      "filename": "Andy_Anger_Management_Certificate.png",
      "url": "https://yourCompany.api.frontapp.com/download/fil_3q8a7mby",
      "content_type": "image/png",
      "size": 4405,
      "metadata": {
        "is_inline": true,
        "cid": "526b45586d0e6b1c484afab63d1ef0be"
      }
    }
  ],
  "is_available_for_all_inboxes": true
}