Email templates Resource

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.	Email templates (JSON)
400	Invalid search query.	Error (JSON)

Response Body

Media type	Data type	Description
application/vnd.blackberry.emailtemplates-v1+json	Email templates (JSON)