Email templates Resource

Variables are used to reference values instead of specifying the actual values.

GET /{tenantGuid}/api/v1/defaultVariables

Available Since:
12.13.1

Get default variables with supported email template types.

Sample request

 
 GET /SRP00000/api/v1/defaultVariables?query=supportedEmailTemplate=ACTIVATION

Sample response body

 
 {
     "defaultVariables": [
         {
             "name": "%ActivationPassword%",
             "supportedEmailTemplates": [
                 "ACTIVATION",
                 "ACTIVATION_AFW",
                 "ACTIVATION_DEP",
                 "ACTIVATION_USER_ENROLLMENT"
             ]
         },
         {
             "name": "%UserName%",
             "supportedEmailTemplates": [
                 "ACTIVATION",
                 "ACTIVATION_AFW",
                 "COMPLIANCE"
             ]
         }
     ]
 }

Request Parameters
Name Location Description
query query (Optional) A query for filtering the default variables results. If not specified, all default variables are returned. Commas or backslashes in query values must be escaped with a backslash.
Field Type Description
supportedEmailTemplate string Type of email template supported by a default variable. See Email template types for a list of supported values.
Response Codes
Code Condition Data type
200 OK.
400 Invalid search query.
Response Body
Media type Data type Description
application/vnd.blackberry.defaultvariables-v1+json Default Variables (JSON)

GET /{tenantGuid}/api/v1/emailTemplates

Available Since:
12.6.0

Get email templates of a specific type or all types.

Sample request

 
 GET /SRP00000/api/v1/emailTemplates?query=type=ACTIVATION

Sample response body

 
 {
  "emailTemplates":
  [
   {
    "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
    "name":"Default activation email",
    "type":"ACTIVATION",
    "default" : true
   },
   {
    "guid":"7f107c0f-f513-4754-956e-f9125201fb66",
    "name":"Consultants activation",
    "type":"ACTIVATION",
    "default" : false
   }
  ]
  }

Request Parameters
Name Location Description
query query (Optional) A query for filtering the email template results. If not specified, all templates are returned. Commas or backslashes in query values must be escaped with a backslash.
Field Type Description
type string Type of email templates to get. See Email template types for a list of supported values.
Response Codes
Code Condition Data type
200 OK.
400 Invalid search query.
Response Body
Media type Data type Description
application/vnd.blackberry.emailtemplates-v1+json Email templates (JSON)