Docs
Calls

Add a routing rule

POSThttps://api.norreach.app/v1/inbound-routing/rules

Adds who answers incoming calls: ai_agent (needs ai_agent_id), human (your team, or one person with assigned_user_id), ivr (the call menu) or voicemail — for one number (phone_number_id) or every number without a rule of its own; priority (higher first), business_hours_only, a greeting (≤ 1000 characters). Fields that don't belong to the type are left out. Owners, admins and managers. dry_run=true answers it as it would be saved.

⚠ calls:routingRole must allow: calls.routingSupports dry_runOperation id: create_routing_rule
POST/inbound-routing/rules
curl -X POST "https://api.norreach.app/v1/inbound-routing/rules" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "route_type": "ai_agent",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "ai_agent_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "priority": 10
}'
Add a routing rule
{
  "id": "0d1e2f3a-4b5c-4d6e-8f7a-8b9c0d1e2f3a",
  "object": "routing_rule",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "route_type": "ai_agent",
  "ai_agent_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "assigned_user_id": null,
  "priority": 10,
  "business_hours_only": false,
  "greeting": null,
  "active": true,
  "created_at": "2026-10-01T08:00:00.000Z"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope calls:routing. API keys and scopes

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

route_typeenumrequired
One of:ai_agenthumanivrvoicemail
phone_number_idstring (uuid) | null
ai_agent_idstring (uuid) | null
assigned_user_idstring (uuid) | null
priorityinteger
business_hours_onlyboolean
greetingstring | null
activeboolean

Response

201application/json— Add a routing rule

idstring (uuid)required

An id (UUID).

object"routing_rule"required
phone_number_idstring (uuid) | nullrequired

Null = every number of the workspace without a rule of its own.

route_typeenumrequired

ai_agent = an AI agent answers; human = your team (the hold queue, or one person); ivr = the call menu; voicemail.

One of:ai_agenthumanivrvoicemail
ai_agent_idstring (uuid) | nullrequired
assigned_user_idstring (uuid) | nullrequired
priorityintegerrequired
business_hours_onlybooleanrequired
greetingstring | nullrequired
activebooleanrequired
created_atstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
409idempotency_in_progressA request with this Idempotency-Key is still running.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.