Visitors

Visitor management

EndpointsCopy Anchor Link

• POST Add note to visitor — Appends an internal note to the visitor metadata. The note text is required.
• POST Add tag to visitor — Adds one tag to the visitor metadata. If the tag is already present, the route keeps the existing tag list unchanged.
• POST Anonymize visitor data (GDPR erasure) — Anonymizes a visitor's PII (identifier, fingerprint, geo data, metadata) in compliance with GDPR Article 17.
• POST Apply an action to multiple visitors — Adds or removes a tag, or blocks or unblocks up to 100 visitors from the current organization in one transactional operation.
• POST Ban a visitor — Creates or updates a ban record for the visitor and also marks the visitor metadata as blocked. reason is optional.
• POST Block visitor — Marks the visitor as blocked in metadata and also creates a project-scoped visitor ban record.
• GET Check if visitor is banned — Returns whether the visitor has an active ban record and includes the ban details when present.
• DELETE Delete a visitor note — Deletes a visitor note by note ID from the visitor metadata and returns a success flag.
• PUT Edit a visitor note — Updates the text of one existing visitor note and keeps its other note fields, including pin state and author metadata, unchanged.
• GET Export visitors as CSV — Streams up to 1000 visitors as a CSV file using the same filtering options as the visitor list route.
• GET Get visitor browsing history — Returns the visitor's page history and time spent on each page. Visitors can only read their own history.
• GET Get visitor by ID — Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.
• GET Get visitor statistics — Returns visitor totals, online visitor count, new-versus-returning counts, and top countries for the requested period.
• GET List visitors — Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range.
• POST Merge duplicate visitor profiles — Atomically reassigns conversations, visitor messages, surveys, CSAT responses, and pending outbox records from one or more source visitors to the target.
• POST Pin or unpin a visitor note — Pins or unpins one visitor note inside the visitor metadata. When the request body is omitted, pinned defaults to true, so calling this route without a body…
• DELETE Remove tag from visitor — Removes one tag from the visitor metadata if it exists. If the tag is already missing, the route still succeeds with the standard delete response.
• DELETE Unban a visitor — Removes the visitor ban record and clears the blocked metadata flags for the visitor.
• DELETE Unblock visitor — Clears the blocked visitor metadata and removes any matching visitor ban record for the current organization.
• PATCH Update visitor profile — Partially updates operator-managed visitor contact details. Omitted fields remain unchanged; null or blank values clear a field without replacing unrelated…