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-b796-4412-94b4-23f940da1dcb",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

Changed in 2 of the 50 revisions of this API.6

  • ca9b053c43735See 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 404

      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