You can define notification policies to limit the use of SMS/voice and email notifications for pairing and authentication.

Parameters for creating/updating notification policies

Property Type Required? Mutable? Description
name String Required Mutable The name to use for the notification policy. Must be unique among the notification policies in the environment.
default Boolean Optional Mutable Indication of whether this policy is the default notification policy for the environment. If the parameter is not provided, the value used is false
countryLimit Object Optional Mutable You can use the countryLimit object to limit the countries where you can send SMS and voice notifications.
countryLimit.type String Required/Optional Mutable Determines the kind of limitation being defined. The possible values are
  • NONE
  • ALLOWED - allows SMS/Voice notifications only for the countries specified with countryLimit.countries
  • DENIED - denies SMS/Voice notifications for the countries specified with countryLimit.countries
countryLimit.deliveryMethods Array Optional Mutable The delivery methods that the defined limitation should be applied to. Content of the array can be SMS, Voice, or both. If the parameter is not provided, the default is SMS and Voice.
countryLimit.countries Array Required/Optional Mutable The countries where the specified methods should be allowed or denied. Use the two-letter country codes from ISO 3166-1.
quotas Array Required Mutable Collection of objects that define the SMS/voice and email limits. Each object contain the following elements: type, deliveryMethods, total. Note that instead of total, you can use the pair of fields: claimed and unclaimed.
quotas[].type String Required Mutable Specifies whether the limit defined is per-user or per environment. Value must be either USER or ENVIRONMENT.
quotas[].deliveryMethods Array Required Mutable The delivery methods for which the limit is being defined. The value can be Email or SMS,Voice. When you use the SMS, Voice option, it means that the combined total of SMS and voice notifications must be below the limit defined. If you are limiting both email and SMS/voice, each limit should be represented by a different object in the quotas array, for example:
"quotas": [{"type": "USER","deliveryMethods": ["SMS","Voice"],"total": 30},{"type": "USER","deliveryMethods": ["Email"],"total": 30}]
quotas[].total Integer Required/Optional Mutable The maximum number of notifications allowed per day.
quotas[].claimed Integer Required/Optional Mutable The maximum number of notifications that can be received and responded to each day. Used in conjunction with unclaimed in place of the single field total.
quotas[].unclaimed Integer Required/Optional Mutable The maximum number of notifications that can be received and not responded to each day. Used in conjunction with claimed in place of the single field total.

Audit reporting events

To see the effects of these events for an API call, see the event types in the Audit Report, Audit Activities API, or Webhook stream.

Service Event
notification_policy NOTIFICATION_POLICY.CREATED
notification_policy NOTIFICATION_POLICY.UPDATED
notification_policy NOTIFICATION_POLICY.DELETED

When you create/update a notification policy, the response also includes the following information: