Email templates

Use email templates to organize email content and add style to make emails stand out to your customers and vendors. Create a variety of email templates to use for different types of transactions, different vendors, or different customers. You can add merge fields to populate emails with dynamic data from Sage Intacct, such as the vendor name, contact information, and so on.

List email templates

get/objects/company-config/email-template

Returns a collection with a key, ID, and link for each email template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/email-template/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/company-config/email-template/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an email template
post/objects/company-config/email-template
Creates a new email template.


SecurityOAuth2 
Request 
Request Body schema: application/json
Email template to create


name
required
string
name for the email template.


 
 Example:  "New Email Template"
subject
required
string
Subject  Enter a combination of text and merge fields as desired to create an informative subject line. This field is required


 
 Example:  "Testing New Email Template"
body
required
string
Message  Enter a combination of text, merge fields, and HTML markup as desired to create and customize your message. This field is required.


 
 Example:  "test message for all to see"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
description
string
Description


 
 Example:  "Test for New Email Template"
object
 
replyTo
required
string
Enter an email address you want the recipient to reply to. This corresponds to the From email address the user sees in the Print/Email dialog box when they send an email from a transaction.


 
 Example:  "[email protected]"
to
string
To The recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
cc
string
Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
bcc
string
Blind Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
object
 
isLogoIncluded
boolean
 Default:  false
Include logo Select this checkbox to include the logo image file identified on the Company Information page in the email template.


 
 Example:  true
verticalPosition
string
 Default:  "bottom"
Vertical logo position  Select whether the logo should appear at the top or bottom of the email.


 Enum: "bottom" "top"  
 Example:  "bottom"
horizontalPosition
string
 Default:  "left"
Horizontal logo position  Select whether the logo should appear on the left or right side of the email.


 Enum: "left" "right"  
 Example:  "left"
includeTxnAttachments
boolean
 Default:  false
Select this checkbox to include documents attached to the transaction, such as receipts, in the email you send from a transaction. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
includeProjectInvoiceTxnAttachments
boolean
 Default:  false
Select this checkbox to include all source document attachments linked to a project invoice when emailing the invoice. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
templateType
string
 Default:  "arInvoice"
Application


 Enum: "Contract" "arInvoice" "arStatement" "orderEntryTxn" "purchasingTxn"  
 Example:  "arInvoice"
useSendersPreferredDateFormat
boolean
 Default:  false
Display dates in the user preference setting


 
 Example:  true
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "New Customer Email Template",
  • "description": "Email template for new customers",
  • "templateType": "purchasingTxn",
  • "email": {},
  • "subject": "Welcome!",
  • "body": "New customers receive a 10% discount on their first subscription order."
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "12",
    • "key": "12",
    • "href": "/objects/company-config/email-template/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an email template
get/objects/company-config/email-template/{key}
Returns detailed information for a specified email template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
 Example:  90
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "id": 12,
  • "key": 12,
  • "audit": {
    • "createdDateTime": "2023-10-20T11:31:45Z",
    • "modifiedDateTime": "2023-10-20T11:31:45Z",
    • "createdBy": "1",
    • "modifiedBy": "1"
    },
  • "status": "active",
  • "name": "New Customer Email Template",
  • "description": "Test for New Email Template",
  • "templateType": "purchasingTxn",
  • "email": {},
  • "subject": "Welcome!",
  • "body": "New customers receive a 10% discount on their first subscription order.",
  • "logo": {
    • "isLogoIncluded": true,
    • "verticalPosition": "bottom",
    • "horizontalPosition": "left"
    },
  • "includeTxnAttachments": false,
  • "includeProjectInvoiceTxnAttachments": false,
  • "useSendersPreferredDateFormat": true,
  • "href": "/objects/company-config/email-template/12"
}
Update an email template
patch/objects/company-config/email-template/{key}
Updates an existing email template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
 Example:  90
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
name
string
name for the email template.


 
 Example:  "New Email Template"
description
string
Description


 
 Example:  "Test for New Email Template"
object
 
replyTo
string
Enter an email address you want the recipient to reply to. This corresponds to the From email address the user sees in the Print/Email dialog box when they send an email from a transaction.


 
 Example:  "[email protected]"
to
string
To The recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
cc
string
Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
bcc
string
Blind Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
subject
string
Subject  Enter a combination of text and merge fields as desired to create an informative subject line. This field is required


 
 Example:  "Testing New Email Template"
body
string
Message  Enter a combination of text, merge fields, and HTML markup as desired to create and customize your message. This field is required.


 
 Example:  "test message for all to see"
object
 
isLogoIncluded
boolean
 Default:  false
Include logo Select this checkbox to include the logo image file identified on the Company Information page in the email template.


 
 Example:  true
verticalPosition
string
 Default:  "bottom"
Vertical logo position  Select whether the logo should appear at the top or bottom of the email.


 Enum: "bottom" "top"  
 Example:  "bottom"
horizontalPosition
string
 Default:  "left"
Horizontal logo position  Select whether the logo should appear on the left or right side of the email.


 Enum: "left" "right"  
 Example:  "left"
includeTxnAttachments
boolean
 Default:  false
Select this checkbox to include documents attached to the transaction, such as receipts, in the email you send from a transaction. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
includeProjectInvoiceTxnAttachments
boolean
 Default:  false
Select this checkbox to include all source document attachments linked to a project invoice when emailing the invoice. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
templateType
string
 Default:  "arInvoice"
Application


 Enum: "Contract" "arInvoice" "arStatement" "orderEntryTxn" "purchasingTxn"  
 Example:  "arInvoice"
useSendersPreferredDateFormat
boolean
 Default:  false
Display dates in the user preference setting


 
 Example:  true
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "New Customer Email SW",
  • "email": {},
  • "includeTxnAttachments": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "6",
    • "key": "6",
    • "href": "/objects/company-config/email-template/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an email template
delete/objects/company-config/email-template/{key}
Deletes an email template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
 Example:  90
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query email templates
post/services/core/query
Use the query service to find email templates that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}