Skip to main content
PUT
Choose who takes a number's calls

Authorizations

Authorization
string
header
required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Path Parameters

number
string
required

Body

application/json

Who takes the number's calls.

call_mode
enum<string>
required

AI_AGENT: the phone agent answers. PASSIVE: Neo does not answer; it rings help_desk_number, the caller's phone keeps ringing until the help desk picks up, and, while the number's ticket notes are on, Neo writes the transcript and a summary of the call to the ticket afterwards. AI_AGENT needs a default company on the number.

Available options:
AI_AGENT,
PASSIVE
help_desk_number
string | null

Required for PASSIVE: a number on the MSP's own phone system that rings its help desk, with its country code. Never the support line forwarded to Neo, and never a Neo number, or the call loops. Ignored for AI_AGENT, which keeps the stored number.

Response

Success.

data
PublicPhoneNumber · object
required

Public projection of a phone_numbers row.

psa_settings and agent_settings are returned as opaque JSON — their inner shapes (which PSA action to take on missing customer, which voice profile, which custom prompt) are tenant-curated and not part of the public contract. Anyone wanting to edit them goes through the dashboard.

agent_settings.attached_memory_ids lists the ids of the MSP-wide memories attached to the number, which the agent reads on every call, except one that was deleted or no longer fits the 4,000-character total. A call uses the newest edit of each, so an id can name an older version.

meta
object
required