Tuesday, July 16, 2024

Static - Email Templates
Action:
GET
Method:
GET
URL: /api/v1/static/emailtemplate/get
Description: Fetch a Static Email Template record based on Identifier
Type Key DataType Notes
Headers api-key String Your Api-Key
Params EmailTemplateID Int32 Email Template Identifier
Params IncludeHeaderImage Boolean Include Header Image (optional default is FALSE)
Params IncludeFooterImage Boolean Include Footer Image (optional default is FALSE)
Params IncludeCSS Boolean Include CSS Text (optional default is FALSE)
Params IncludeEmailBody Boolean Include Email Body (optional default is FALSE)
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Email Template record.
{
 "EmailTemplate ID": 57,
 "Name": "Verification Email",
 "Description": "Test Verification Email",
 "EmailSubject": "Please use below verification code",
 "Header Image": [Binary array of the image],
 "Footer Image": [Binary array of the image],
 "CSS": "CSS Text for template",
 "ButtonLabel": "",
 "EmailBody":"Email Body in HTML format",
 "EmailTemplateStatus": 1,
 "EmailTemplateType": 4,
 "VerificationEmailTemplate ID": 0,
 "BusinessUnitID": 10,
 "BusinessUnitName": "Default"
}
Field Data Type
EmailTemplate ID Int 32
Name Text 150
Description Text 300
EmailSubject Text 150
Header Image Binary Array
Footer Image Binary Array
CSS Text 2000
ButtonLabel Text 150
EmailBody Text
EmailTemplateStatus Bit
EmailTemplateType Text 2000
VerificationEmailTemplate ID Int 32
BusinessUnitID Int 32
BusinessUnitName Text 2000
Action:
GET ALL
Method:
GET
URL: /api/v1/static/emailtemplate/getall
Description: Fetch all Static Email Template records
Type Key DataType Notes
Headers api-key String Your Api-Key
Params IncludeHeaderImage Boolean Include Header Image (optional default is FALSE)
Params IncludeFooterImage Boolean Include Footer Image (optional default is FALSE)
Params IncludeCSS Boolean Include CSS Text (optional default is FALSE)
Params IncludeEmailBody Boolean Include Email Body (optional default is FALSE)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Static Email Template records.
[{
 "EmailTemplate ID": 57,
 "Name": "Verification Email",
 "Description": "Test Verification Email",
 "EmailSubject": "Please use below verification code",
 "Header Image": [Binary array of the image],
 "Footer Image": [Binary array of the image],
 "CSS": "CSS Text for template",
 "ButtonLabel": "",
 "EmailBody":"Email Body in HTML format",
 "EmailTemplateStatus": 1,
 "EmailTemplateType": 4,
 "VerificationEmailTemplate ID": 0,
 "BusinessUnitID": 10,
 "BusinessUnitName": "Default"
}]
Field Data Type
EmailTemplate ID Int 32
Name Text 150
Description Text 300
EmailSubject Text 150
Header Image Binary Array
Footer Image Binary Array
CSS Text 2000
ButtonLabel Text 150
EmailBody Text
EmailTemplateStatus Bit
EmailTemplateType Text 2000
VerificationEmailTemplate ID Int 32
BusinessUnitID Int 32
BusinessUnitName Text 2000