Skip to main content
PATCH
Update inbound routing policy

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

id
string
required

Opaque policy ID.

Body

application/json

Patch a webhook-backed inbound routing policy. If scope or target IDs change, PHONE_NUMBER requires phone_number_id, AGENT requires agent_id, and PARTNER clears both target IDs.

scope
enum<string>

Policy scope. Runtime resolution priority is PHONE_NUMBER, then AGENT, then PARTNER.

Available options:
PHONE_NUMBER,
AGENT,
PARTNER
phone_number_id
string<uuid>

PHONE_NUMBER target DID. Use only with scope PHONE_NUMBER.

agent_id
string<uuid>

AGENT target. Use only with scope AGENT.

name
string

Policy label used in partner admin tooling.

Required string length: 1 - 200
enabled
boolean

When false, the policy is stored but not evaluated.

webhook_url
string<uri>

HTTPS endpoint that receives the inbound.route event.

webhook_secret
string | null
write-only

Optional webhook signing secret. Write-only; null clears it.

timeout_ms
integer

Policy decision webhook timeout in milliseconds.

Required range: 250 <= x <= 5000
failure_action
null | enum<string>

Fallback action when webhook fails.

Available options:
ANSWER_WITH_AI,
REJECT
allowed_actions
enum<string>[] | null

Optional allowlist for webhook response actions. Use null to clear and allow all.

Action values supported by inbound route policy responses.

Available options:
ANSWER_WITH_AI,
SELECT_AGENT,
TRANSFER,
REJECT

Response

Policy updated.

success
boolean
data
object