Instance Settings

Update instance communication settings

Changed on

Replaces the SMS country blocklist for this instance. Pass the full set of ISO 3166-1 alpha-2 country codes that should be blocked; codes that aren't recognized as SMS-tier countries are silently dropped from the persisted list. Omitting blocked_country_codes is a no-op.

patch/instance/communication

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/instance/communication
  • Auth: HTTP bearer

Request body

blocked_country_codesstring[] nullable

ISO 3166-1 alpha-2 country codes to block for SMS delivery. Whole-list replacement. Codes must be uppercase, 2-letter, and unique within the array.

Response

Success

object'instance_communication' required
blocked_country_codesstring[] required

ISO 3166-1 alpha-2 country codes that are blocked for SMS delivery on this instance. Codes that aren't recognized are silently dropped.

Changes