Email Template

What can you do with EmailTemplate?


Properties

Property Details
id
"id": 879
Type: Number
This is the unique numeric identifier for the EmailTemplate
ownerId
"ownerId": 319
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
emailTemplateTypeId
"emailTemplateTypeId": 800
Type: Number
Unique identifier for the associated EmailTemplateType object.
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
body
"body": "Hello World"
Type: String
localeId
"localeId": 549
Type: Number
Unique identifier for the associated Locale object.
eventRegistrationId
"eventRegistrationId": 763
Type: Number
Unique identifier for the associated EventRegistration object.
tokenContextTypeId
"tokenContextTypeId": 776
Type: Number
Unique identifier for the associated TokenContextType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • emailTemplateTypeId
  • description
  • isActive
  • subject
  • fromName
  • fromEmailAddress
  • body
  • localeId
  • eventRegistrationId
  • tokenContextTypeId

DataFlow PATCH objects:


End Points

DELETEapi/v1/EmailTemplate/{id:int}
Delete an instance of the EmailTemplate object.
GETapi/v1/EmailTemplate
Retrieve all of the EmailTemplate objects.
GETapi/v1/EmailTemplate/Metadata
Retrieve all of the meta data details of the EmailTemplate object.
GETapi/v1/EmailTemplate/Metadata/{option}
Retrieve all the meta data details of the EmailTemplate object based on provided options.
{option}Metadata options for the EmailTemplate object.
GETapi/v1/EmailTemplate/Paged
Retreive all of the EmailTemplate objects in a paged fashion.
GETapi/v1/EmailTemplate/{id:int}
Retrieve an instance of the EmailTemplate object by it's ID.
{id:int}Unique identifier for the EmailTemplate object.
POSTapi/v1/EmailTemplate
Create a new instance of the EmailTemplate object.
PUTapi/v1/EmailTemplate/{id:int}
Update an existing instance of the EmailTemplate object.