HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Remove entries from SMS and Voice suppression list for a tenant

patch
https://{tenanturl}/v1.0/suppression/phone/tenant

Removes regex-based phone number patterns and/or country codes from 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 countryFilterType is provided and differs from the current value, the countryFilterType is updated to the new value. Any patterns and/or countries included in the request are removed from the existing list.

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 remove from 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
204

SMS and Voice suppression list entries removed successfully.

Updated 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago

Did this page help you?