Create EmailTemplateFile

POST

api

sys

emailtemplatefiles

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/emailtemplatefiles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Language": 123,
  "Name": "<string>",
  "Subject": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Language": 123,
    "Name": "<string>",
    "Subject": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Language: 123, Name: '<string>', Subject: '<string>'})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eLanguage — Language values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

Request Body

Required Fields

integer

required

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

integer

required

Obsolete legacy language enum; use FileLanguage to select the configured location language instead..

string

required

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

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

Optional Fields

integer

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

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..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/emailtemplatefiles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Language": 0,
    "Name": "",
    "Subject": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/emailtemplatefiles',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Language: 0,
      Name: '',
      Subject: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/emailtemplatefiles',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Language': 0,
        'Name': '',
        'Subject': ''
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the emailtemplatefile was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "EmailTemplateFile was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Language: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Language"
    }
  ],
  "WasSuccessful": false
}

Create EmailTemplateFile

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/emailtemplatefiles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Language": 123,
  "Name": "<string>",
  "Subject": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Language": 123,
    "Name": "<string>",
    "Subject": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Language: 123, Name: '<string>', Subject: '<string>'})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400