{ "id": 12345, "identifier": "key1", "description": "Invoice for contract <<contract.number>>", "body": "<div style=\"padding-bottom: 30px\"> Hi <<customer.firstname>>, <br>\n This is a sample HTML-Template to show you, how to use the power of Output.Rocks ;)\n </div>", "text": "Email text <<customer.firstname>>", "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "brandIdentifier": "default", "active": true, "activeFrom": "2024-01-01", "subClientDefault": false, "subClientId": 3, "subClientDescription": "Branch Office A" }

SPA Standard Email Templates

SPA: Retrieves a Standard Email Template

Retrieves a single standard email template by ID.

GET/api/spa/standard-email-templates/{id}

SPA: Retrieves a Standard Email Template

curl --request GET \
  --url 'https://app.output.rocks/api/spa/standard-email-templates/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 12345,
  "identifier": "key1",
  "description": "Invoice for contract <<contract.number>>",
  "body": "<div style=\"padding-bottom: 30px\"> Hi <<customer.firstname>>, <br>\n                          This is a sample HTML-Template to show you, how to use the power of Output.Rocks ;)\n                          </div>",
  "text": "Email text <<customer.firstname>>",
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00",
  "brandIdentifier": "default",
  "active": true,
  "activeFrom": "2024-01-01",
  "subClientDefault": false,
  "subClientId": 3,
  "subClientDescription": "Branch Office A"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

StandardEmailTemplate identifier

Response

200application/json

StandardEmailTemplate resource

integer

Identifier generated by Output.Rocks.

Example: 12345

identifier

stringrequired

Unique identifier

Example: "key1"

description

string

StandardEmailTemplate description / title. <<>>-Syntax can be used for dynamical generation.

Example: "Invoice for contract <<contract.number>>"

body

string

Email body <<>>-Syntax can be used for dynamical generation.

Example: "<div style=\"padding-bottom: 30px\"> Hi <<customer.firstname>>, <br>\n This is a sample HTML-Template to show you, how to use the power of Output.Rocks ;)\n </div>"

text

string

Email text <<>>-Syntax can be used for dynamical generation.

Example: "Email text <<customer.firstname>>"

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

brandIdentifier

stringrequired

Example: "default"

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

subClientDefault

boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"