POST v1/bunits/{bunitId}/smtp
Create outgoing email (SMTP) settings for a business unit.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit of the smtp settings | integer |
Required |
Body Parameters
The smtp settings object
SmtpSettingsName | Description | Type | Additional information |
---|---|---|---|
SenderEmailAddress |
Gets or sets the email address that will be used as sender, or from-address. |
string |
Required. |
CatchAllAddress |
Whenever an automated email is sent using the smtp settings a copy will be sent to this email. |
string |
None. |
Host |
Gets or sets the name or IP address of the host used for SMTP transactions. |
string |
Required. |
Port |
Gets or sets the port used for SMTP transactions. |
integer |
Required. |
EnableSsl |
Specify whether the SmtpClient uses Secure Sockets Layer (SSL)/Transport Layer Security (TLS) to encrypt the connection. |
boolean |
None. |
Username |
Gets or sets the username used when SSL is enabled. |
string |
Required if SSL/TLS is enabled. |
Password |
Gets or sets the password used when SSL is enabled. |
string |
Passwords are never exposed through the API. Required if SSL/TLS is enabled. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The smtp settings with the information created
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.