Update Notification Policy
PUT {{apiPath}}/environments/{{envID}}/notificationsPolicies/{{notificationPolicyID}}
Use the PUT {{apiPath}}/environments/{{envID}}/notificationsPolicies/{{notificationPolicyID}} endpoint to update the specified notification policy. The policy is specified with its ID.
You can modify any of the fields that are specified when creating a notification policy, including the name of the policy.
Prerequisites
- See Notifications and Notification Policies for important overview information.
| Property | Type | Required? |
|---|---|---|
name | String | Required |
default | Boolean | Optional |
quotas | Array | Required |
quotas\[\].type | String | Required |
quotas\[\].deliveryMethods | Array | Required |
quotas\[\].total | Integer | Required/Optional |
quotas\[\].claimed | Integer | Required/Optional |
quotas\[\].unclaimed | Integer | Required/Optional |
See the Notification policy data model for full property descriptions.
Request Body
{"name"=>"Per-User - used/not used - Notification Policy", "quotas"=>[{"type"=>"USER", "deliveryMethods"=>["SMS", "Voice"], "claimed"=>35, "unclaimed"=>45}], "default"=>false}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsPolicies/9ac09c18-27d9-477f-a338-3438cea37601"},"environment":{"href":"https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"9ac09c18-27d9-477f-a338-3438cea37601","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Per-User - used/not used - Notification Policy","quotas":[{"type":"USER","deliveryMethods":["SMS","Voice"],"unclaimed":45,"claimed":35}],"updatedAt":"2022-05-15T09:42:50.786Z","createdAt":"2022-05-15T09:22:40.971Z","default":false}