Register a visitor's information before creating a new Omnichannel room. You can set basic information such as name, phone, custom fields, and the initial department.
The response may include externalIds when the visitor has been linked to an external system by an omnichannel app. This field cannot be set through this endpoint's request body.
Changelog
| Version | Description |
|---|---|
| 8.4.0 | Added externalIds field to the visitor response. |
{
"visitor": {
"name": "Livechat Visitor",
"email": "visitor@rocket.chat",
"department": "Support",
"token": "iNKE8a6k6cjbqWhWd",
"phone": "55 51 5555-5555",
"customFields": [
{
"key": "address",
"value": "Rocket.Chat street",
"overwrite": true
}
]
}
}Enter the body parameters in the visitor object.
The visitor's name.
The visitor's email.
The department that the visitor wants to register to.
Enter a random unique string as the visitor token.
The visitor's phone number.
The agent's username.
Enter the custom field key, value, and whether you want to overwrite this information.
{
"visitor": {
"_id": "6a22b1765528fa64dd29de70",
"username": "guest-10",
"status": "online",
"ts": "2026-06-05T11:22:30.664Z",
"_updatedAt": "2026-06-05T11:22:30.665Z",
"name": "Postman Test Visitor",
"phone": [
{
"phoneNumber": "+15551234567"
}
],
"token": "test-token-12345",
"visitorEmails": [
{
"address": "postman-test@example.com"
}
]
},
"success": true
}Channel-specific external identifiers (e.g. WhatsApp BSUID). Set by omnichannel apps via apps-engine, not through this REST endpoint's request body.
ID of the omnichannel app that registered this identifier.
External identifier value (e.g. Meta BSUID).
Optional app-specific metadata (e.g. WhatsApp username).
Bad Request
{
"success": false,
"error": "Match error: Missing key 'visitor'"
}{
"success": false,
"error": "Match error: Missing key 'token' in field visitor"
}