SMS Templates

Retrieve a SMS Template

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_templates.

get/smstemplate/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/smstemplate/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_templates

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

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e859f8c27a21Revision changes
    • info

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