Skip to main content
POST
Edit Block Rule
You can only update fields like reason or is_active. Phone numbers and scope (global/inbound) are immutable after creation.

Headers

string
required
Your API key for authentication.

Path Parameters

number
required
The unique ID of the block rule to update.

Body Parameters

string
Optional reason for blocking. Set to null to remove an existing reason.
boolean
Controls whether the block rule is currently enforced. Set to false to disable or true to re-enable. Use null to leave unchanged.

Response

object
The updated block rule object.
number
Unique ID of the block rule.
string
The phone number being blocked.
boolean
Indicates if the block applies globally.
string|null
The specific inbound number the block applies to (if not global).
string
UUID of the owning organization.
string|null
Reason for the block, if present.
boolean
Whether the block rule is currently active.
string
ISO timestamp when the rule was created.
string
ISO timestamp of the last update.
null|array
null on success, or a list of validation or lookup errors.

Docs for agents: llms.txt