Skip to main content
PATCH
Change a number's after-hours instructions, business hours, passive note visibility and transfer setting

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

A change to a number's after-hours instructions, business hours, passive-mode note visibility or transfer setting. A field left out keeps its stored value.

after_hours_instructions
string | null

Used in place of the number's custom instructions on calls that start outside business hours or on a holiday. Send null or an empty string to turn them off.

business_hours
PublicBusinessHoursUpdate · object | null

The business hours to change. A field left out keeps its stored value.

passive_note_visible_to_customer
boolean | null

For a number whose call_mode is PASSIVE: true makes the note with the call's transcript and summary visible to the customer on the ticket, false (the default) keeps it internal. Left out, the stored value stays.

transfer_mode
enum<string> | null

How the agent puts a caller through to a person: OFF (never), BLIND (hands the call over and leaves it), WARM (holds the caller, briefs whoever answers, and connects them only when that person agrees) or BOTH (the custom instructions say which kind each case gets, warm where they do not say). The number to transfer to comes from the custom instructions.

Available options:
OFF,
BLIND,
WARM,
BOTH

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