SMTP / Setting

What can you do with SMTPSetting?


Properties

Property Details
id
"id": 462
Type: Number
This is the unique numeric identifier for the SMTPSetting
ownerId
"ownerId": 667
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
serverHostName
"serverHostName": "Hello World"
Type: String
serverPort
"serverPort": 470
Type: Number
userName
"userName": "Hello World"
Type: String
password
"password": "Hello World"
Type: String
fromEmailAddress
"fromEmailAddress": "Hello World"
Type: String
fromName
"fromName": "Hello World"
Type: String
useSecureConnection
"useSecureConnection": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • serverHostName
  • serverPort
  • userName
  • password
  • fromEmailAddress
  • fromName
  • useSecureConnection

DataFlow PATCH objects:


End Points

DELETEapi/v1/SMTP/Setting/{id:int}
Delete an instance of the SMTPSetting object.
GETapi/v1/SMTP/Setting
Retrieve all of the SMTPSetting objects.
GETapi/v1/SMTP/Setting/Metadata
Retrieve all of the meta data details of the SMTPSetting object.
GETapi/v1/SMTP/Setting/Metadata/{option}
Retrieve all the meta data details of the SMTPSetting object based on provided options.
{option}Metadata options for the SMTPSetting object.
GETapi/v1/SMTP/Setting/Paged
Retreive all of the SMTPSetting objects in a paged fashion.
GETapi/v1/SMTP/Setting/{id:int}
Retrieve an instance of the SMTPSetting object by it's ID.
{id:int}Unique identifier for the SMTPSetting object.
POSTapi/v1/SMTP/Setting
Create a new instance of the SMTPSetting object.
PUTapi/v1/SMTP/Setting/{id:int}
Update an existing instance of the SMTPSetting object.
UNKNOWNapi/v1/SMTP/Setting/SendTestEmail/{id:int}