Docs
Calls

Who answers a number: the AI agent or the call menu

PUThttps://api.norreach.app/v1/phone-numbers/{id}/inbound-mode

Switches who answers one of the workspace's bought numbers — ai (the AI agent) or menu (the call menu: AI, your team, voicemail) — exactly as Settings › Inbound calls does: the number moves first, and the saved mode never claims what the number isn't. A number still settling or not switchable is 409 / 422. Owners, admins and managers. dry_run=true checks it and changes nothing.

⚠ calls:routingRole must allow: calls.routingSupports dry_runOperation id: set_number_inbound_mode
PUT/phone-numbers/{id}/inbound-mode
curl -X PUT "https://api.norreach.app/v1/phone-numbers/{id}/inbound-mode" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "menu"
}'
Who answers a number: the AI agent or the call menu
{
  "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "object": "routing_number",
  "number": "+46812345678",
  "label": "Stockholm office",
  "inbound_mode": "menu"
}

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

Path parameters

idstring (uuid)pathrequired

An id (UUID).

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

modeenumrequired
One of:aimenu

Response

200application/json— Who answers a number: the AI agent or the call menu

idstring (uuid)required

An id (UUID).

object"routing_number"required
numberstringrequired
labelstring | nullrequired
inbound_modeenumrequired
One of:aimenu

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.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409conflictThat conflicts with the current state.
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.