Sign in
Email Templates

Create a new Email Template

OAuth Scope

This endpoint requires the following OAuth scope manage_templates.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/emailtemplate.json

Request body

namestring required

Unique name of the email template. Used to identify and select the template in the system. This field is mandatory and must be unique among all email templates in the account.

subjectstring

Subject line for the email template. Supports variable placeholders like {job.job_address} which are replaced with actual values when the email is generated. This field defines what appears in the subject line of emails sent using this template.

messagestring

The HTML body content of the email template. Supports rich text formatting and variable placeholders like {job.contact_first}, {document}, {vendor.name}, etc., which are replaced with actual values when the email is generated.

uuidstring uuid

Unique identifier for this record

Example request

{
  "uuid": "123e4567-41a3-431c-b04a-23f942440c5b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 3 of the 50 revisions of this API.15

  • 638a8df09bf41See the full diff
    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • e859f8c27a211See the full diff
    • ○

      the security scope manage_templates was added to the endpoint's security scheme oauth2

      api-security-scope-added