Update Notifications Settings (SMTP)
PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/emailDeliverySettings
The PUT /environments/{{envID}}/notificationsSettings/emailDeliverySettings endpoint updates the SMTP notifications settings for the specified environment.
Prerequisites
- See Notifications and Notifications Settings for important overview information.
| Property | Type | Required? |
|---|---|---|
from.address | String | Optional |
from.name | String | Optional |
host | String | Required |
password | String | Required |
port | String | Optional |
replyTo.address | String | Optional |
replyTo.name | String | Optional |
username | String | Required |
See the Notifications settings (SMTP) data model for full property descriptions.
Request Body
{"host"=>"email-smtp.amazonaws.com", "port"=>465, "username"=>"smtp_username", "password"=>"{{password}}", "from"=>{"name"=>"from_name", "address"=>"from@pingidentity.com"}, "replyTo"=>{"name"=>"reply_name", "address"=>"reply@pingidentity.com"}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/emailDeliverySettings"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"host":"email-smtp.amazonaws.com","port":465,"protocol":"SMTPS","username":"smtp_username","from":{"name":"from_name","address":"from@pingidentity.com"},"replyTo":{"name":"reply_name","address":"reply@pingidentity.com"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"updatedAt":"2022-05-02T18:55:47.461Z"}