PUT v1/bunits/{bunitId}/smtp/{smtpId}
Update outgoing email (SMTP) settings.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the smtp settings | integer |
Required |
smtpId |
The ID of the smtp settings | integer |
Required |
Body Parameters
The smtp settings object
SmtpSettings| Name | 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. |
AuthenticationType |
Gets or sets the method used for authenticating against the SMTP server. |
SmtpAuthenticationType |
None. |
Username |
Gets or sets the username. When using OAuth2, this is the email address of the mailbox sending the emails. |
string |
Required if SSL/TLS is enabled and basic authentication is used. |
Password |
Gets or sets the password used for basic authentication. |
string |
Passwords are never exposed through the API. Required if SSL/TLS is enabled and basic authentication is used. |
OAuthTenantId |
Gets or sets the ID of the Microsoft Entra tenant the OAuth2 application is registered in. |
string |
Required if OAuth2 is used. |
OAuthClientId |
Gets or sets the client (application) ID of the OAuth2 application. |
string |
Required if OAuth2 is used. |
OAuthClientSecret |
Gets or sets the client secret of the OAuth2 application. |
string |
Passwords are never exposed through the API. Required if OAuth2 is used. |
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 updated smtp settings
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.