Add SMS and Voice suppression list configuration for a tenant

Adds regex-based phone number patterns and country filter settings to the tenant’s SMS and Voice suppression list. The request may include patterns, countries, or both. A tenant can have either a country allow list or a block list, but not both. Supported countryFilterType values are ALLOW and BLOCK.

If the countryFilterType is changed for an existing list, all existing entries are retained. Country entries are reassigned to the new countryFilterType and merged with the country entries provided in the request. Pattern entries are merged with the existing patterns.

Note: To change the countryFilterType between BLOCK and ALLOW, it is recommended to first delete the existing list using the DELETE API, then add the new list using the POST API.

Entitlements required: manageSmsVoiceOtpSuppressionList (Manage SMS and voice OTP suppression list).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A list of regex phone number patterns and/or ISO 3166-1 alpha-2 country codes to add to the tenant phone suppression list

patterns
array of strings

List of regex phone number patterns. This field is optional. The request may contain patterns, countries, or both.

patterns
string
enum

Country filter type for the tenant. Supported values are ALLOW and BLOCK. A tenant can have either an allow list or a block list, but not both.

Allowed:
countries
array of strings

List of ISO 3166-1 alpha-2 country codes. This field is optional. The request may contain patterns, countries, or both.

countries
Responses
200

SMS and Voice suppression list entries added successfully.

Language
URL
LoadingLoading…
Response
Choose an example:
application/json