Update Notifications Settings
PUT {{apiPath}}/environments/{{envID}}/notificationsSettings
The PUT /environments/{{envID}}/notificationsSettings
endpoint updates the notifications settings for the specified environment. If an administrator sets a trusted email domain and trusted email address, then the from
attribute must be configured to have email notifications sent using the trusted email address. Configuration of the replyTo
attribute is optional.
This sample shows how to update the from.address
and replyTo.address
attribute values to designate trusted email addresses.
Note: If you omit the from
and replyTo
attributes from the PUT
request body, the trusted email address values are removed and the from
attribute value is reset to the PingOne default noreply@pingidentity.com
.
Prerequisites
- See Notifications and Notifications Settings for important overview information.
Property | Type | Required? |
---|---|---|
deliveryMode | String | Required |
from.address | String | Optional |
from.name | String | Optional |
replyTo | String | Optional |
restrictions.smsVoiceQuote.daily | Integer | Required |
smsProvidersFallbackChain | String | Optional |
whitelist.user.id | String | Required |
See the Notifications settings data model for full property descriptions.
Request Body
{"whitelist"=>[{"user"=>{"id"=>"{{userID}}"}}], "smsProvidersFallbackChain"=>["TwilioPhoneDeliverySettingsId", "PINGONE_TWILIO"], "deliveryMode"=>"WHITELIST", "from"=>{"name"=>"noreply", "address"=>"noreply@domain.com"}, "replyTo"=>{"name"=>"noreply", "address"=>"noreply@domain.com"}}