fbpx

SMTP Configurations

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/SMTPConfig

Method(s):

get,put,delete

Response Formats:

JSON, XML

Description:

This method allows to retrieve, create, update and delete SMTP Configuration.

Parameters

SMTP Configuration details

NameTypeDescription
ServerNameStringSMTP Configuration server name
PortNumberSmallIntSMTP Configuration server using port number
UserNameStringSMTP Configuration user name
PasswordStringSMTP Configuration email server password
OverrideSMTPConfigBooleanOverride SMTP config(if true, overrides KashFlow emails with SMTP configuration)
Encryption TypeStringSMTP Configuration Encryption type (None, SSL or TLS)
FromNameStringCompany name in KashFlow
FromEmailStringSender’s Email address

 

 

GET Operation

GET of SMTP Config returns SMTP Configuration for the user.

URL : /SMTPConfig

Example response for GET of SMTP Configuration

{
 "ServerName": "smtp.gmail.com",
 "PortNumber": 25,
 "UserName": "aatish@gmail.com",
 "Password": "password",
 "OverrideSMTPConfig": true,
 "EncryptionType": "SSL",
 "FromName": "C And G Installations",
 "FromEmail": "aatish@kashflow.com"
}Response : 200 

PUT Operation

Updates SMTP configuration if exist else creates.

URL : /SMTPConfig

Example request for PUT of SMTP Configuration

{
  "ServerName":"smtp.gmail.com",
  "PortNumber":25,
  "UserName":"aatish@gmail.com",
  "Password":"password",
  "EncryptionType":"SSL",
  "FromName":"C And G Installations",
  "FromEmail":"aatish@kashflow.com",
  "OverrideSMTPConfig": true
} Response : 204

DELETE Operation

Deletes SMTP configuration for a user.

URL : /SMTPConfig

See how KashFlow works with your business and your books