Get one EmailTemplateFile

GET

api

sys

emailtemplatefiles

{id}

Get one EmailTemplateFile

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Language": 123,
  "FileLanguageId": 123,
  "Name": "<string>",
  "Subject": "<string>",
  "FileContents": "<string>",
  "EditorDesign": "<string>",
  "IsTextOnly": true,
  "FromName": "<string>",
  "FromEmail": "<string>",
  "CCEmail": "<string>",
  "CCOEmail": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An email template override defines the subject, body, and optional sender or copy recipients for an automated message at one location in one configured language; built-in files are used when no override is saved.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the EmailTemplateFile-Read role.

Path Parameters

integer

required

The Id of the EmailTemplateFile record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/emailtemplatefiles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/emailtemplatefiles/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/emailtemplatefiles/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location whose automated email template this record overrides..

integer

Obsolete legacy language enum; use FileLanguage to select the configured location language instead.. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

integer

ID of the configured location language for this template override; together with Name and Business it identifies the saved template..

string

Built-in email message identifier this record overrides, such as the identifier for a welcome, invoice, booking confirmation, or reminder email; required and limited to 254 characters..

string

Required email subject line, up to 254 characters; supported message tokens are replaced before the email is queued..

string

Email body content for this location and language; supported message tokens are replaced before the email is queued..

string

Optional Unlayer design JSON used to continue visual editing; FileContents remains the exported HTML used for delivery..

boolean

Whether this template is marked as text-only; the current message dispatch path stores and transfers this flag without using it to transform the body..

string

Optional sender display name passed to email delivery, limited to 254 characters..

string

Optional sender email address passed to email delivery, limited to 254 characters..

string

Optional carbon-copy recipient email address passed to email delivery, limited to 254 characters..

string

Optional blind-carbon-copy recipient email address passed to email delivery, limited to 254 characters..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Language": 0,
  "FileLanguageId": null,
  "Name": "",
  "Subject": "",
  "FileContents": null,
  "EditorDesign": null,
  "IsTextOnly": false,
  "FromName": null,
  "FromEmail": null,
  "CCEmail": null,
  "CCOEmail": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "EmailTemplateFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one EmailTemplateFile

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/emailtemplatefiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Language": 123,
  "FileLanguageId": 123,
  "Name": "<string>",
  "Subject": "<string>",
  "FileContents": "<string>",
  "EditorDesign": "<string>",
  "IsTextOnly": true,
  "FromName": "<string>",
  "FromEmail": "<string>",
  "CCEmail": "<string>",
  "CCOEmail": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200