The template object

Templates save you time and promote consistency in communication with your customers. Instead of typing out a new message each time you try to schedule an appointment or answer a question about billing, simply use a template.

AttributeTypeDescription
typestringThe type of the template Possible values: ["custom", "review_invite", "review_invite_backup"]
user.uidstringPodium unique identifier for the referenced resource.
titlestringThe title of the template
location.uidstringPodium unique identifier for the referenced resource.
textstringThe title of the template.
variablesarray[string]
organization.uidstringPodium unique identifier for the referenced resource.
subjectstringThe subject of the template.
uidstringPodium unique identifier for The unique identifier of the template..
createdAtstringWhen the template was created.
updatedAtstringThe date/time the template was last updated.
attachmentUrlstringURL of template attachment.
accessLevelstringThe access level of the template. If locationUid is filled, this property will be LOCATION. Possible values: ["location", "organization"]
deletedAtstringWhen the template was deleted.
isFavoritebooleanFlag that indicates if this template is the favorite.
lastUsedAtstringWhen the template was last used.
nonDeletablebooleanFlag that indicates if template can be deleted or not.
templateItemsarrayThe template items object.
templateItems[].datastringThe data of the template item.
templateItems[].typestringThe type of the template item.
templateItems[].keysarrayThe template items object.
templateItems[].keys[].namestringThe name of the key.
templateItems[].keys[].requiredbooleanFlag to indicate if key is required or not.
templateItems[].titlestringThe title of the template item.
templateItems[].bodystringThe body of the template item.
templateItems[].uidstringPodium unique identifier for The unique identifier of the template Item..
templateItems[].subtitlestringThe subtitle of the template item.
templateItems[].attachmentUrlstringThe attachment URL of the template item.
templateItems[].attachmentContentTypestringThe application content-type of the template item.
templateItems[].applicationUidstringPodium unique identifier for The unique identifier for the application of the template item..
templateItems[].applicationUrlstringThe application URL of the template item.
templateItems[].iconUrlstringThe icon URL of the template item.
{
  "type": "custom",
  "user": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "title": "",
  "location": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "text": "",
  "variables": [
    ""
  ],
  "organization": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "subject": "",
  "uid": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2015-01-23T23:50:07Z",
  "updatedAt": "2015-01-23T23:50:07Z",
  "attachmentUrl": "https://www.podium.com/",
  "accessLevel": "location",
  "deletedAt": "2015-01-23T23:50:07Z",
  "isFavorite": false,
  "lastUsedAt": "2015-01-23T23:50:07Z",
  "nonDeletable": false,
  "templateItems": [
    {
      "data": "",
      "type": "",
      "keys": [
        {
          "name": "",
          "required": false
        }
      ],
      "title": "",
      "body": "",
      "uid": "00000000-0000-0000-0000-000000000000",
      "subtitle": "",
      "attachmentUrl": "https://www.podium.com/",
      "attachmentContentType": "",
      "applicationUid": "00000000-0000-0000-0000-000000000000",
      "applicationUrl": "https://www.podium.com/",
      "iconUrl": "https://www.podium.com/"
    }
  ]
}