Get an email template

Get an email template

get

Path parameters

idstringRequired

The id of the email template.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/email-templates/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "countryCode": "US",
    "languageCode": "en",
    "subject": "Welcome to Our Service!",
    "body": "Dear {{user.email_address}}, welcome to our platform. We are excited to have you on board!",
    "tags": "#Welcome",
    "event": {
      "id": "sApKpllz4sAplsmzha",
      "guid": "00000000-0000-0000-0000-000000000000",
      "groupCodeName": "Example",
      "code": "CODE",
      "name": "Name",
      "description": "Description",
      "trackingLevel": 1,
      "tags": "Tags",
      "zOrder": 1,
      "status": "Active",
      "isSystem": false
    }
  },
  "errors": []
}