API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Sys

Reference

Emailtemplatefile

The emailtemplatefile object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this emailtemplatefile
BusinessId: Id required
FileContents: string optional
FileLanguageId: Id optional
IsTextOnly: bool optional
Name: string required
Subject: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this emailtemplatefile
SystemId: string optional api-only
User defined data about this emailtemplatefile. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "FileContents": "FileContent",
  "FileLanguageId": 12345678,
  "IsTextOnly": false,
  "Name": "Name",
  "Subject": "Subject",
  "UniqueId": "0c16327b-f2d2-4b40-8660-018c34f81187",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a EmailTemplateFile

This endpoint allows you to GET a list of emailtemplatefiles based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/emailtemplatefiles?...

🔒 Requires role "EmailTemplateFile-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search emailtemplatefile records based on their different properties.
Id number
?Id=12345678
EmailTemplateFile_Business Business
?EmailTemplateFile_Business=...
EmailTemplateFile_FileContents string
?EmailTemplateFile_FileContents=...
EmailTemplateFile_FileLanguage Language
?EmailTemplateFile_FileLanguage=...
EmailTemplateFile_IsTextOnly bool
?EmailTemplateFile_IsTextOnly=...
EmailTemplateFile_Name string
?EmailTemplateFile_Name=...
EmailTemplateFile_Subject string
?EmailTemplateFile_Subject=...

Range search querystring parameters
Lets you search emailtemplatefile records based on a range of date or numeric values.
To_EmailTemplateFile_CreatedOn date
?To_EmailTemplateFile_CreatedOn=2010-01-01T20:32
From_EmailTemplateFile_CreatedOn date
?From_EmailTemplateFile_CreatedOn=2010-01-01T20:32
To_EmailTemplateFile_UpdatedOn date
?To_EmailTemplateFile_UpdatedOn=2010-01-01T20:32
From_EmailTemplateFile_UpdatedOn date
?From_EmailTemplateFile_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/emailtemplatefiles?EmailTemplateFile_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "FileLanguage": ,
        "Name": "Name",
        "Subject": "Subject",
        "FileContents": "FileContent",
        "IsTextOnly": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7ffa9d29-cc3e-4231-9b25-16f6e383bd90",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}

Find EmailTemplateFiles by IDs

Gets one or more emailtemplatefile records based on their Id. 
GET https://spaces.nexudus.com/api/sys/emailtemplatefiles?EmailTemplateFile_Id=[:id1,:id2,...]

🔒 Requires role "EmailTemplateFile-List"

Querystring parameters
EmailTemplateFile_Id: array requried
?EmailTemplateFile_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/emailtemplatefiles?EmailTemplateFile_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "FileLanguage": ,
        "Name": "Name",
        "Subject": "Subject",
        "FileContents": "FileContent",
        "IsTextOnly": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "adc6bb17-7f1f-4b53-b38c-532f09d867a5",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}

Get single EmailTemplateFile by Id

Gets one emailtemplatefile record by its Id. 
GET https://spaces.nexudus.com/api/sys/emailtemplatefiles/:Id

🔒 Requires role "EmailTemplateFile-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/emailtemplatefiles/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "FileContents": "FileContent",
  "FileLanguageId": 12345678,
  "IsTextOnly": false,
  "Name": "Name",
  "Subject": "Subject",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "31725bd1-86ee-42c0-a97d-a79b9c8eddf4",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new EmailTemplateFile

Creates a new emailtemplatefile. 
POST https://spaces.nexudus.com/api/sys/emailtemplatefiles

🔒 Requires role "EmailTemplateFile-Create"

Body parameters
BusinessId: number required
FileLanguageId: number optional
Name: string required
Subject: string required
FileContents: string optional
IsTextOnly: bool optional

Example request

POST https://spaces.nexudus.com/api/sys/emailtemplatefiles
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "BusinessId": 12345678,
    "FileLanguageId": 12345678,
    "Name": "Name",
    "Subject": "Subject",
    "FileContents": "FileContent",
    "IsTextOnly": false,
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Update EmailTemplateFile

Updates an existing emailtemplatefile. 
PUT https://spaces.nexudus.com/api/sys/emailtemplatefiles

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

🔒 Requires role "EmailTemplateFile-Edit"

Body parameters
Id: number required
The unique Id of the emailtemplatefile to update.
BusinessId: number cleared if missing
FileLanguageId: number cleared if missing
Name: string cleared if missing
Subject: string cleared if missing
FileContents: string cleared if missing
IsTextOnly: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/sys/emailtemplatefiles
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
    "Id": 12345678,
    "BusinessId": 12345678,
    "FileLanguageId": 12345678,
    "Name": "Name",
    "Subject": "Subject",
    "FileContents": "FileContent",
    "IsTextOnly": false,
}

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}

Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}

Delete EmailTemplateFile

Deletes an existing emailtemplatefile by its Id. 
DELETE https://spaces.nexudus.com/api/sys/emailtemplatefiles/:Id

🔒 Requires role "EmailTemplateFile-Delete"

URL parameters
Id: number required
The unique Id of the emailtemplatefile to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/emailtemplatefiles/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}

Commands

Commands allow to perform actions against one or more emailtemplatefile records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for emailtemplatefile records. 
GET https://spaces.nexudus.com/api/sys/emailtemplatefiles/commands

Example request

GET https://spaces.nexudus.com/api/sys/emailtemplatefiles/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]

Run Command

Runs a command based on its Key and one or more emailtemplatefile record IDs. 
POST https://spaces.nexudus.com/api/sys/emailtemplatefiles/runacommand
🔒 Requires role "EmailTemplateFile-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/emailtemplatefiles/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==


{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}

Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}

Enumerated values

Language

GET /api/utils/enums?name=eLanguage

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.