Skip to main content
PUT
Use the id and channel from List entry points, and choose a destination:

Email and web chat

Email and web chat belong to the whole agent. Send the agent in master_workflow_id, then use group with that same agent to switch the channel on, or none to switch it off. The web chat id is webchat: followed by the agent ID.

When the agent already has one

If the agent already has an entry point of the same channel, the API returns 400 channel_type_already_connected. Send replace: true to disconnect the old one and connect this one. This works for WhatsApp, SMS, iMessage, Instagram, and Messenger.

Phone numbers

Moving a phone number can change who answers live calls, so the API can ask you to confirm:
1

Send the change

The API answers 409 phone_inbound_binding_confirmation_required. conflict explains what would change, and required_confirmation holds the confirmation.
2

Repeat it with the confirmation

Send the same request again with required_confirmation copied, unchanged, as confirmation. Do not rename its keys.
If you get 409 phone_inbound_binding_changed, the number changed in the meantime: list the entry points again and start over. With 409 inbound_reception_publication_busy (retryable: true), another change to the same agent’s call setup is still running: wait retry_after_ms and send the request again.

When the agent is still being prepared for calls

Connecting a phone number to an agent can take longer than the request, for example when the agent’s incoming calls were off and Nexor has to prepare the agent for calls first. In that case the API answers 202 Accepted with the entry point and an assignment:
A 202 means accepted, not connected yet. You do not need to send the request again: Nexor finishes the connection on its own, usually within a minute. Read the number with List entry points until one of these happens: The connection stops as failed when the agent’s call setup fails and cannot recover, when the same error happens twice in a row, or when the number is still not answering calls 10 minutes after the request. In the last case error_code is the last error seen, or phone_inbound_assignment_timeout if there was none. Nexor stops retrying a failed connection; a new request starts a new attempt with a new 10 minutes. If the request itself finds that the agent’s call setup failed, the API answers 409 phone_inbound_assignment_failed with retryable: false and the same assignment, with status: "failed" and its error_code. A 409 phone_inbound_binding_failed means connecting the number stopped with an error; binding has the details. In both cases, fix the cause and send the request again. A 409 phone_inbound_binding_pending means the number is still connecting: read it back as above.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.

Body

application/json
channel
enum<string>
required
Available options:
whatsapp,
imessage,
unsupervised-whatsapp,
phone,
sms,
instagram,
messenger,
email,
webchat
id
string
required

Entry point id from List entry points.

Minimum string length: 1
destination
object
required

{"type": "group", "id": <agent id>}, {"type": "agent", "id": <task id>}, or {"type": "none"}.

confirm
enum<boolean>
required

Must be true.

Available options:
true
master_workflow_id
string<uuid>

Required for email and webchat: the agent whose channel you switch on or off.

replace
boolean
default:false

Disconnect the agent's current entry point of the same channel and connect this one.

confirmation
object

Only for phone numbers: the required_confirmation object from the previous 409, unchanged.

Response

Entry point after the change.

entry_point
object
required
Last modified on October 13, 2026