Sign in
SMS Templates

Retrieve a SMS Template

OAuth Scope

This endpoint requires the following OAuth scope manage_templates.

get/smstemplate/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the SMS Template

Response

SMS Template record retrieved successfully

namestring required

The name of the SMS template. This is a unique identifier for the template within the system. Examples include 'Tech Delayed Template', 'Parts Ordered Template', etc.

messagestring

The SMS message content that will be sent to recipients. Supports template variables like {job.contact_first}, {vendor.name}, {job.generated_job_id}, {job.total_price}, etc. Maximum length is determined by the SMS service provider's limit. Messages exceeding this limit will not be saved.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "uuid": "123e4567-5079-49f1-9988-23482d4b7feb",
  "edit_date": "2025-09-01 12:00:00"
}

Changes