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 inbound_reception_publication_busy, wait retry_after_ms and retry.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

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 September 28, 2026