Clerk API (unofficial showcase)
PATCH/instance/communication

Update instance communication settings

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
blocked_country_codesarray<string>optional
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.

2 status codes
200Success
objectstringrequired
Allowed:instance_communication
blocked_country_codesarray<string>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.
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 422 is returned: Invalid request parameters.