Skip to main content

Templates

Status: Trusted Tester

Templates that can be used for emails and other messaging services.

idstring
Example: AG-12345/type/email/template-id/TEM-12345
typestring

Possible values: [reviewRequestTemplates]

Default value: reviewRequestTemplates
attributes object
namestring

A user friendly description for the template.

Example: My Preferred Sites Review Request
emailMetadata object

Additional information about the template.

subjectstring

The subject line of the email.

Example: Thank you for choosing us!
replyToemail

The email address to which the customer should reply.

Example: jondoe@mail.com
smsMetadata object

Additional information about the template.

urluri

The url that will customer will be sent to.

Example: https://www.yoursite.com/reviews/customer-123
greetingstring

The sms message prefix. {first_name} is an optional template variable that can be used within the greeting.

Example: Hi {first_name}
prefixstring

Generally a shortened version of the company name.

templateTypestring
  • myListing: The link within the sms message will direct the customer to the my listing page.
  • preferredReviewSites: The link within the sms message will direct the customer to the preferred review sites.
  • custom: The link within the sms message will direct the customer to the custom url configured within the metadata.

Possible values: [myListing, preferredReviewSites, custom]

contentstring

The content of the template.

Example: Hi {{.customerName}}, <br> <br> Thank you for your business! We'd love to know more about your latest experience with us. <br> <br> {{.buttonUrl}} <br> <br> Thank you, <br> John Doe
languageLocaleCodestring

The local language that the template was written in.

Note: We currently have a limited set of allowed languages but expect to support many more in the future. When the requested language is not supported US English will be used.

It should be a single BCP47/RFC5646 language tag. This is an ISO 639-1 Alpha-2 language code in lowercase and an ISO 3166-1 Alpha-2 country code in uppercase, separated by a dash.

Examples:

  • en-US English (US)
  • fr-FR French (France)

Possible values: Value must match regular expression ^[a-z]{2}-[A-Z]{2}$

Example: en-US
templateTypestring

The type of the template.

Possible values: [email, sms]

Example: email
relationships object
businessLocation object
data object
idstringrequired

The ID of the business location the template belongs to.

Possible values: non-empty

typestring

Possible values: [businessLocation]

Default value: businessLocation
Templates
{
  "id": "AG-12345/type/email/template-id/TEM-12345",
  "type": "reviewRequestTemplates",
  "attributes": {
    "name": "My Preferred Sites Review Request",
    "emailMetadata": {
      "subject": "Thank you for choosing us!",
      "replyTo": "jondoe@mail.com"
    },
    "smsMetadata": {
      "url": "https://www.yoursite.com/reviews/customer-123",
      "greeting": "Hi {first_name}",
      "prefix": "string",
      "templateType": "myListing"
    },
    "content": "Hi {{.customerName}},\n<br>\n<br>\nThank you for your business! We'd love to know more about your latest experience with us.\n<br>\n<br>\n{{.buttonUrl}}\n<br>\n<br>\nThank you,\n<br>\nJohn Doe",
    "languageLocaleCode": "en-US",
    "templateType": "email"
  },
  "relationships": {
    "businessLocation": {
      "data": {
        "id": "string",
        "type": "businessLocation"
      }
    }
  }
}