SMS Templates

Create a new SMS 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/smstemplate.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/smstemplate.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

Request body

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

Example request

{
  "uuid": "123e4567-78d5-45cb-9489-23f945ba341b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes