Skip to navigation

Remove one outbound number-agent link

Removes only this pair; refused while a call is active on it (conflict, details.reason=active_call). Preserves all other agents and numbers and call history. Already absent is a no-op after valid precondition. Uses number ETag.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

number_idstringRequired1-128 characters
Resource identity within the authenticated workspace.
agent_idstringRequired1-128 characters
Resource identity within the authenticated workspace.

Headers

If-MatchstringRequired

Strong ETag from the resource being changed. Draft/tool/variable/publication operations use the complete agent draft ETag; number operations use the number ETag; MCP update uses its own ETag. Never retry a stale edit by blindly using a fresh ETag. Agent identity edits use the identity ETag; knowledge-source reingest uses the source ETag. A stale revision returns 409: draft_conflict for agent, draft, variable, tool, MCP server and publication-token checks; conflict with details.reason=stale_revision for phone numbers and knowledge sources. A missing header returns 428 revision_required. Same-intent replay uses the original If-Match and returns its receipt before checking current revision.

Idempotency-KeystringRequired1-255 characters

Stable key per logical intent, 1–255 printable characters. Persist it before sending. Retry the same key/body after an uncertain result for 24 hours. A changed body conflicts. Beyond retention, reconcile the resource before retrying; this is not permanent deduplication. Current authorization is rechecked on replay. Evaluation order: authenticate and check current authorization; look up intent; replay its stored receipt before checking the current revision; only a new intent evaluates If-Match and executes. Fingerprint includes method, path, body and original If-Match. A changed request returns idempotency_key_reused. The server stores only a keyed (HMAC) fingerprint, and no error or response ever returns a fingerprint or hash of a request. In-flight intent returns 409 idempotency_in_progress with Retry-After; retry the same intent after reconciliation. Receipts describe that attempt, not current resource state. A replay returns the original status code and body, with the response header Idempotent-Replayed: true.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
ETagstringOptional
Strong number revision. Use for number assignment edits.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.
Idempotent-ReplayedstringOptional

true when this response replays a stored Idempotency-Key result. The status and body equal the original.

Response

Remove one outbound number-agent link.

idstring<=128 characters
Opaque number identifier. Do not parse its contents.
numberstringformat: "^\+[1-9][0-9]{7,14}$"
labelstring or null
providerstring
revisionstring
supports_inboundboolean
supports_outboundboolean
inbound_agent_idstring or null<=128 characters
inbound_setupstring

Open response vocabulary. Preserve unknown values; never assume they mean success.

next_actionstring or null
Safe setup guidance, never a callback secret or signed URL.
outbound_agent_idslist of strings
outbound_primary_agent_idslist of stringsOptional

The agents, among outbound_agent_ids, whose primary outbound number this is. An agent has at most one primary: the first number assigned, then the oldest remaining one when it is removed. An agent whose numbers predate this field has none until its next outbound assignment change. createCall without from_number_id dials from it when the agent has several numbers.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
428
Precondition Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error