fbpx

Email Templates

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!

URL:

https://api.kashflow.com/v2/emailtemplates

Method(s):

get

Response Formats:

JSON, XML

Description:

This method allows you to retrieve email templates set up for user account.

Parameters

NameTypeDescription
NumberNumericUser specific number assigned to template.
BodyStringEmail template body which will be sent as email body. The body may contain strings enclosed within # symbols. Please refer Email Text Substitutions Resource for further assistance on these special strings.
NameStringEmail template name.Template name is unique for a user.
SubjectStringEmail template subject which will be sent as email subject.
IsHtmlBooleanFlag indicating whether body is in HTML format or not.

GET Operation

Returns list of email templates set for user account.

URL : /emailtemplates

Example response for GET of email templates list


[{
    "Body": "Please see attached invoice. Regards,Accounts Dept. rediff",
    "IsHtml": false,
    "Name": "Default Email Template",
    "Number": 1,
    "Subject": "Invoice from rediff"
}, {
    "Body": "Please see attached invoice. Regards,Accounts Dept. rediff",
    "IsHtml": false,
    "Name": "Statements",
    "Number": 2,
    "Subject": ""
}]

Retrieves details of email template.

URL : /emailtemplates/{templatenumber}
{templatenumber} in the URL will be replaced by unique number assigned to each template

Example response for GET of email template


{
    "Body": "Please see attached invoice. Regards,Accounts Dept. rediff",
    "IsHtml": false,
    "Name": "Default Email Template",
    "Number": 1,
    "Subject": "Invoice from rediff"
}

See how KashFlow works with your business and your books