TAG LINE
TAG LINE
SMALL TITLE

Email Template

(API Version v9)


What can you do with EmailTemplate?


Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the EmailTemplate
ownerId
READ-ONLY
"ownerId": 5
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Hello World"
Type: String
emailTemplateTypeId
"emailTemplateTypeId": 27
Type: Number
Unique identifier for the associated EmailTemplateType object.
emailTemplateTypeName
"emailTemplateTypeName": "Sample Name"
Type: String
The name of the object associated with the emailTemplateTypeId property.
description
"description": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
subject
"subject": "Hello World"
Type: String
fromName
"fromName": "Hello World"
Type: String
fromEmailAddress
"fromEmailAddress": "Hello World"
Type: String
localeId
"localeId": 25
Type: Number
Unique identifier for the associated Locale object.
localeName
"localeName": "Sample Name"
Type: String
The name of the object associated with the localeId property.
eventRegistrationId
"eventRegistrationId": 0
Type: Number
Unique identifier for the associated EventRegistration object.
eventRegistrationName
"eventRegistrationName": "Sample Name"
Type: String
The name of the object associated with the eventRegistrationId property.
tokenContextTypeId
"tokenContextTypeId": 23
Type: Number
Unique identifier for the associated TokenContextType object.
tokenContextTypeName
"tokenContextTypeName": "Sample Name"
Type: String
The name of the object associated with the tokenContextTypeId property.
storageLocationId
"storageLocationId": 0
Type: Number
Unique identifier for the associated StorageLocation object.
storageLocationName
"storageLocationName": "Sample Name"
Type: String
The name of the object associated with the storageLocationId property.
documentIdentifier
"documentIdentifier": "Hello World"
Type: String
fileName
"fileName": "Hello World"
Type: String
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
updated
READ-ONLY
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the EmailTemplate object.

Standard PATCH objects:

  • emailTemplateCurrencyFormat - create, update, delete

DataFlow PATCH objects:

  • emailTemplate - create, update, delete
  • emailTemplateCurrencyFormat - create, update, delete

End Points

DELETEEmailTemplate/{id}
Delete an instance of the EmailTemplate object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the EmailTemplate object.
Delete an instance of the EmailTemplate object.
DELETE EmailTemplate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "emailTemplate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETEmailTemplate/
Retrieve all of the EmailTemplate objects.
Retrieve all of the EmailTemplate objects.
GET EmailTemplate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 12,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "emailTemplateTypeId": 16,
            "emailTemplateTypeName": "Sample Text Data",
            "description": "Sample Text Data",
            "isActive": true,
            "subject": "Sample Text Data",
            "fromName": "Sample Text Data",
            "fromEmailAddress": "Sample Text Data",
            "localeId": 19,
            "localeName": "Sample Text Data",
            "eventRegistrationId": 0,
            "eventRegistrationName": "Sample Text Data",
            "tokenContextTypeId": 0,
            "tokenContextTypeName": "Sample Text Data",
            "storageLocationId": 6,
            "storageLocationName": "Sample Text Data",
            "documentIdentifier": "Sample Text Data",
            "fileName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETEmailTemplate/Paged
Retrieve all of the EmailTemplate objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the EmailTemplate objects in a paged fashion.
GET EmailTemplate/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "emailTemplateTypeId": 9,
                "emailTemplateTypeName": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "subject": "Sample Text Data",
                "fromName": "Sample Text Data",
                "fromEmailAddress": "Sample Text Data",
                "localeId": 22,
                "localeName": "Sample Text Data",
                "eventRegistrationId": 8,
                "eventRegistrationName": "Sample Text Data",
                "tokenContextTypeId": 25,
                "tokenContextTypeName": "Sample Text Data",
                "storageLocationId": 0,
                "storageLocationName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "fileName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETEmailTemplate/{id}
Retrieve an instance of the EmailTemplate object by its ID.
{id}Unique identifier for the EmailTemplate object.
Retrieve an instance of the EmailTemplate object by its ID.
GET EmailTemplate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 26,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "emailTemplateTypeId": 8,
        "emailTemplateTypeName": "Sample Text Data",
        "description": "Sample Text Data",
        "isActive": true,
        "subject": "Sample Text Data",
        "fromName": "Sample Text Data",
        "fromEmailAddress": "Sample Text Data",
        "localeId": 21,
        "localeName": "Sample Text Data",
        "eventRegistrationId": 12,
        "eventRegistrationName": "Sample Text Data",
        "tokenContextTypeId": 1,
        "tokenContextTypeName": "Sample Text Data",
        "storageLocationId": 20,
        "storageLocationName": "Sample Text Data",
        "documentIdentifier": "Sample Text Data",
        "fileName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETEmailTemplate/{id}/Detail
Retrieve deep detail of the EmailTemplate object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the EmailTemplate object.
Retrieve deep detail of the EmailTemplate object by its ID.
GET EmailTemplate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 14,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "emailTemplateTypeId": 24,
        "emailTemplateTypeName": "Sample Text Data",
        "description": "Sample Text Data",
        "isActive": true,
        "subject": "Sample Text Data",
        "fromName": "Sample Text Data",
        "fromEmailAddress": "Sample Text Data",
        "localeId": 16,
        "localeName": "Sample Text Data",
        "eventRegistrationId": 4,
        "eventRegistrationName": "Sample Text Data",
        "tokenContextTypeId": 25,
        "tokenContextTypeName": "Sample Text Data",
        "storageLocationId": 9,
        "storageLocationName": "Sample Text Data",
        "documentIdentifier": "Sample Text Data",
        "fileName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z",
        "details": {
            "emailTemplateCurrencyFormats": [
                {
                    "identity": 64,
                    "emailTemplateId": 69,
                    "emailTemplateName": "Sample Text Data",
                    "currencyId": 3,
                    "currencyName": "Sample Text Data",
                    "localeId": 17,
                    "localeName": "Sample Text Data",
                    "currencyCode": "Sample Text Data"
                }
            ]
        }
    }
}
PATCHEmailTemplate/Upload/{id}
Update or Add the EmailTemplate object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the EmailTemplate object.
Update or Add the EmailTemplate object and optionally make changes to any child objects.
PATCH EmailTemplate/Upload/{id}

{
    "details": {},
    "emailTemplates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Sample Text Data",
                "emailTemplateTypeId": 4,
                "description": "Sample Text Data",
                "isActive": true,
                "subject": "Sample Text Data",
                "fromName": "Sample Text Data",
                "fromEmailAddress": "Sample Text Data",
                "localeId": 5,
                "eventRegistrationId": 23,
                "tokenContextTypeId": 2,
                "storageLocationId": 16,
                "documentIdentifier": "Sample Text Data",
                "fileName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "emailTemplate",
                "instance": {
                    "identity": 1,
                    "ownerId": 14,
                    "ownerName": "Sample Text Data",
                    "name": "Sample Text Data",
                    "emailTemplateTypeId": 3,
                    "emailTemplateTypeName": "Sample Text Data",
                    "description": "Sample Text Data",
                    "isActive": true,
                    "subject": "Sample Text Data",
                    "fromName": "Sample Text Data",
                    "fromEmailAddress": "Sample Text Data",
                    "localeId": 17,
                    "localeName": "Sample Text Data",
                    "eventRegistrationId": 19,
                    "eventRegistrationName": "Sample Text Data",
                    "tokenContextTypeId": 3,
                    "tokenContextTypeName": "Sample Text Data",
                    "storageLocationId": 16,
                    "storageLocationName": "Sample Text Data",
                    "documentIdentifier": "Sample Text Data",
                    "fileName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTEmailTemplate/Upload
Create a new instance of the EmailTemplate object.
Create a new instance of the EmailTemplate object.
POST EmailTemplate/Upload

{
    "name": "Sample Text Data",
    "emailTemplateTypeId": 9,
    "description": "Sample Text Data",
    "isActive": true,
    "subject": "Sample Text Data",
    "fromName": "Sample Text Data",
    "fromEmailAddress": "Sample Text Data",
    "localeId": 8,
    "eventRegistrationId": 4,
    "tokenContextTypeId": 19,
    "storageLocationId": 12,
    "documentIdentifier": "Sample Text Data",
    "fileName": "Sample Text Data",
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "emailTemplateTypeId": 10,
                "emailTemplateTypeName": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "subject": "Sample Text Data",
                "fromName": "Sample Text Data",
                "fromEmailAddress": "Sample Text Data",
                "localeId": 22,
                "localeName": "Sample Text Data",
                "eventRegistrationId": 6,
                "eventRegistrationName": "Sample Text Data",
                "tokenContextTypeId": 25,
                "tokenContextTypeName": "Sample Text Data",
                "storageLocationId": 7,
                "storageLocationName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "fileName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTEmailTemplate/Upload/{id}
Update an existing instance of the EmailTemplate object.
Update an existing instance of the EmailTemplate object.
PUT EmailTemplate/Upload/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "emailTemplateTypeId": 0,
    "description": "Sample Text Data",
    "isActive": true,
    "subject": "Sample Text Data",
    "fromName": "Sample Text Data",
    "fromEmailAddress": "Sample Text Data",
    "localeId": 2,
    "eventRegistrationId": 26,
    "tokenContextTypeId": 16,
    "storageLocationId": 18,
    "documentIdentifier": "Sample Text Data",
    "fileName": "Sample Text Data",
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "emailTemplateTypeId": 16,
                "emailTemplateTypeName": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "subject": "Sample Text Data",
                "fromName": "Sample Text Data",
                "fromEmailAddress": "Sample Text Data",
                "localeId": 10,
                "localeName": "Sample Text Data",
                "eventRegistrationId": 20,
                "eventRegistrationName": "Sample Text Data",
                "tokenContextTypeId": 13,
                "tokenContextTypeName": "Sample Text Data",
                "storageLocationId": 25,
                "storageLocationName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "fileName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}