Skip to content

Reassign a phone number

PATCH
/phone-numbers/update-assignee

Move a number to a different person, and tell voice about it.

Not a label: the assignee drives inbound ring targeting, missed-call notification and which numbers appear in that person’s outbound caller-ID rotation pool.

ADMIN-ONLY through this API. The app also accepts the number’s current assignee or its creator, but an API key is an ORGANISATION credential with no user_id, so it can never be either - leaving it to fall through to the role check is what made this route 403 for every key before the role was supplied.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Move a number to a different person.

Mirrors phone_numbers.interfaces.fastapi.dtos.UpdateAssigneeRequest.

object
assignee
required

Who owns it now. This drives inbound ring targeting, missed-call notification and the outbound caller-ID pool - it is not a label.

string
phone_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