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
| Name | Type | Description |
|---|---|---|
| ServerName | String | SMTP Configuration server name |
| PortNumber | SmallInt | SMTP Configuration server using port number |
| UserName | String | SMTP Configuration user name |
| Password | String | SMTP Configuration email server password |
| OverrideSMTPConfig | Boolean | Override SMTP config(if true, overrides KashFlow emails with SMTP configuration) |
| Encryption Type | String | SMTP Configuration Encryption type (None, SSL or TLS) |
| FromName | String | Company name in KashFlow |
| FromEmail | String | Sender’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": "[email protected]",
"Password": "password",
"OverrideSMTPConfig": true,
"EncryptionType": "SSL",
"FromName": "C And G Installations",
"FromEmail": "[email protected]"
}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":"[email protected]",
"Password":"password",
"EncryptionType":"SSL",
"FromName":"C And G Installations",
"FromEmail":"[email protected]",
"OverrideSMTPConfig": true} Response : 204
DELETE Operation
Deletes SMTP configuration for a user.URL : /SMTPConfig