This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!




Response Formats:



This method allows you to send email.


ToStringComma or semicolon separated email “TO” addresses.
CcStringComma or semicolon separated email “CC” addresses.
BccStringComma or semicolon separated email “BCC” addresses.
SubjectStringEmail subject
BodyStringEmail body
AttachmentsObjectObject containing information about two types of supported attachment types i.e. DocumentUrls, FileAttachments. Described in more details below.
isHtmlBooleanFlag indicating whether email body is in HTML format. If true then email body will be sent in HTML format.

Attachment Supported

Attachment more than 5MB are not supported and 10MB is the maximum limit for all attachments.

1) DocumentUrls

FileNameStringFilename is mandatory it can be same as name specified in the document URL. If different name is given then it will overwrite the actual file name in the URL.
UrlStringDocument URL e.g. permalinks.

2) FileAttachments

NameStringAttachment filename. Filename is mandatory field.
AttachmentContentStringFile content in BASE64 string format. This content can be obtained from online tools like base64Encoder

POST Operation

Sends email with specified information.

URL : /email?async=false

Request Parameters

asyncOptional boolean value which indicates whether to send email asynchronously or synchronously. Email will be sent asynchronously if not specified.

Example request for POST of Email

"Bcc" : "[email protected]",
"Body" : "Email content",
"Cc" : "[email protected]",
"IsHtml" : true,
"Subject" : "Test Email",
"To" : "[email protected]",
"Attachments" : {
"DocumentUrls" : [{ 
"FileName" : "best.pdf",
"Url" : ""
}] ,
"FileAttachments" : [{ 
"Name" : "best.pdf",
"AttachmentContent" : " BASE64String"

Example response for POST of Email

Status Code: 200

See how IRIS KashFlow works with your business and your books