Update Routing Rule - API

Partial update of a routing rule. All fields are optional, but at least one editable field must be present in the body (otherwise returns 400 No editable fields provided).

Updating phoneNumbers detaches removed numbers and attaches added numbers; inbound conflicts are checked the same way as create.

Non-editable: type (creation-time only).

Header field gating — the existing rule's type controls which header field is allowed:

• headers → outbound rules only.
• headersToAttributes → inbound rules only.

Responses:

• 200 success — returns the updated routing rule.
• 400 validation failure (missing editable fields, invalid includeHeaders, phone numbers not found, inbound conflict, wrong header field for rule type).
• 404 routing rule not found.
• 500 internal server error.

HTTP method and endpoint

PATCH

|

https://api.videosdk.live/v2/sip/routing-rule/:ruleId

Headers Parameters

Authorization

REQUIRED

values: YOUR_TOKEN_WITHOUT_ANY_PREFIX

This will be a JWT token generate using VideoSDK ApiKey and Secret.

Note that the token will not include any prefix such as "Basic " or "Bearer ". Just pass a token as value.

You can generate a new token by refering this Guide: Generate Auth token

Content-Type

REQUIRED

values: application/json

This is usefull for json body parameters, so that VideoSDK servers can understand that the incoming body parameter will be a JSON string.

Parameters

ruleId

REQUIRED

The unique ID of the routing rule to update.

Body Parameters

name

OPTIONAL

New name for the routing rule.

phoneNumbers

OPTIONAL

Replacement set of e164 numbers attached to this rule. Removed numbers are detached; added numbers are attached (and inbound conflicts are checked).

agentId

OPTIONAL

Agent ID to dispatch calls to.

agentMetadata

OPTIONAL

Metadata forwarded to the agent.

room

OPTIONAL

Room dispatch config — { type, prefix, id, pin }.

includeHeaders

OPTIONAL

Which SIP headers are surfaced. One of ALL, SIP_X_HEADERS, NONE.

headersToAttributes

OPTIONAL

Inbound rules only. Map of incoming SIP header → participant attribute. Returns 400 on outbound rules.

headers

OPTIONAL

Outbound rules only. Custom SIP headers attached to outgoing INVITEs. Returns 400 on inbound rules.

allowedNumbers

OPTIONAL

Allowlist of caller numbers. Empty array means no restriction.

allowedIpAddresses

OPTIONAL

Allowlist of caller IPs. Empty array means no restriction.

tags

OPTIONAL

Replacement tag array.

recording

OPTIONAL

Whether calls should be recorded.

dtmf

OPTIONAL

Whether DTMF events are captured.

noiseCancellation

OPTIONAL

Whether noise cancellation is enabled.

hidePhoneNumber

OPTIONAL

If true, the caller's number is hidden when dispatching.

Response Parameters

id

Unique identifier of the routing rule.

name

Updated name.

type

Rule direction — inbound or outbound (unchanged; creation-time only).

numbers

Phone numbers attached to this rule after the update.

room

Room dispatch object — { type, prefix, id, pin }.

agentId

ID of the dispatched agent, or null.

agentMetadata

Metadata forwarded to the agent.

apiKey

Resolved API key.

includeHeaders

Which SIP headers are surfaced — ALL, SIP_X_HEADERS, NONE.

headersToAttributes

Inbound rules only — SIP header → attribute map.

headers

Outbound rules only — custom SIP headers attached to outgoing INVITEs.

allowedNumbers

Allowlist of caller numbers.

allowedIpAddresses

Allowlist of caller IP addresses.

tags

Tags applied to the rule.

recording

Whether calls are recorded.

dtmf

Whether DTMF events are captured.

noiseCancellation

Whether noise cancellation is enabled.

hidePhoneNumber

Whether the caller's number is hidden when dispatching.

createdAt

Creation timestamp (ISO 8601).

updatedAt

Last-update timestamp (ISO 8601).

PATCH

|

https://api.videosdk.live/v2/sip/routing-rule/:ruleId

NodeJS

• cURL
• NodeJS
• PHP
• Python

import fetch from 'node-fetch';
const options = {
	method: "PATCH",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
	body: JSON.stringify({
	"name": "Renamed rule",
	"phoneNumbers": [
		"+14155551234",
		"+14155555678"
	],
	"agentId": "$YOUR_AGENT_ID",
	"agentMetadata": {
		"team": "support",
		"tier": "gold"
	},
	"room": {
		"type": "dynamic",
		"prefix": "blank"
	},
	"includeHeaders": "ALL",
	"headersToAttributes": {},
	"headers": {
		"X-Customer-Id": "cust_42"
	},
	"allowedNumbers": [],
	"allowedIpAddresses": [],
	"tags": [
		"support"
	],
	"recording": true,
	"dtmf": false,
	"noiseCancellation": true,
	"hidePhoneNumber": true
}),
};
const url= `https://api.videosdk.live/v2/sip/routing-rule/:ruleId`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);

RESPONSE

{
  "id": "rr_abc123",
  "name": "Renamed rule",
  "type": "inbound",
  "numbers": [
    "+14155551234",
    "+14155555678"
  ],
  "room": {
    "type": "dynamic",
    "prefix": "blank",
    "id": null,
    "pin": null
  },
  "agentId": "agent_xyz",
  "agentMetadata": {
    "team": "support",
    "tier": "gold"
  },
  "hidePhoneNumber": true,
  "tags": [
    "support"
  ],
  "apiKey": "ak_resolved",
  "recording": true,
  "dtmf": false,
  "noiseCancellation": true,
  "allowedNumbers": [],
  "allowedIpAddresses": [],
  "includeHeaders": "ALL",
  "headersToAttributes": {},
  "createdAt": "2026-05-11T10:00:00.000Z",
  "updatedAt": "2026-05-11T10:05:00.000Z"
}