The Visitors API provides operations for visitor bootstrap, email capture, visitor tracking, live visitor monitoring, and public visitor status checks.
Endpoints
| Method | Path | Purpose |
| POST | /auth | Bootstrap Guest and issue Visitor Session |
| PATCH | /auth/:guestId/email | Capture Guest email |
| GET | /auth/guest/:guestId/tracking | Get browser/device tracking |
| GET | /auth/detect-location | Detect visitor location |
| GET | /visitors/live | List live visitors |
| GET | /api/public/guests/:guestId/status | Check Guest deletion state |
Visitor Session Bootstrap
The audited bootstrap DTO includes fields such as:
{
“channelId”: “<CHANNEL_ID>”,
“email”: “visitor@example.com”,
“name”: “Alex”,
“sessionId”: “<SESSION_ID>”,
“clientInstanceId”: “<CLIENT_INSTANCE_ID>”
}
The exact required/optional combination is defined by the current CreateGuestDto.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk