Skip to content

Set a number's voice-side assignee

PATCH
/voice/numbers/assignee

Point a number’s voice-side assignment at someone else.

The VOICE half of PATCH /phone-numbers/update-assignee, which does this and updates the CDP record. Published separately because the app’s propagation to voice is best-effort and only logs a warning when it fails - so the two records can disagree, and this is the way to reconcile them without re-running the whole reassignment.

Sending assigned_to: "" clears the assignment. Assigning a WORK number also creates the person’s phone-directory row, which is what makes them findable by name to the receptionist.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Point a number’s voice-side assignment at someone else.

Mirrors graph8_livekit.schemas.numbers.UpdateAssignee minus org_id.

assigned_to is REQUIRED but may be the empty string, which is how voice spells “clear the assignment” - its own normalisation passes falsy input through untouched for exactly that reason.

object
assigned_to
required

Email of the new assignee, or "" to clear it. Normalised by voice before storage so inbound ring targeting, the dialer assignee filter and per-rep stat redaction all compare equal.

string
number
required

The number to reassign, E.164.

string

Responses

200

Successful Response

object
data
required

An open envelope for a purchase result, a release, or an A2P job.

Open on purpose. A purchase returns the stored row (whose capability and provider-metadata keys differ per provider), a workflow start returns a workflow_id, and the A2P reconcile returns per-number outcomes that grow as carriers add statuses. Pinning it would silently drop whatever the provider reported that this contract had not caught up on.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string