API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreCommunityBlogYour Apps

The Visitor model

Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform.
The Visitors resource provides methods to fetch, update, convert, and delete.

Object Models


typestringValue is 'visitor'
idstringThe Intercom defined id representing the Visitor.
user_idstringAutomatically generated identifier for the Visitor.
anonymousbooleanIdentifies if this visitor is anonymous.
emailstringThe email of the visitor.
phonestringThe phone number of the visitor.
namestringThe name of the visitor.
pseudonymstringThe pseudonym of the visitor.
app_idstringThe id of the app the visitor is associated with.
las_request_atintegerThe time the Lead last recorded making a request.
created_atintegerThe time the Visitor was added to Intercom.
remote_created_atintegerThe time the Visitor was added to Intercom.
signed_up_atintegerThe time the Visitor signed up for your product.
updated_atintegerThe last time the Visitor was updated.
session_countintegerThe number of sessions the Visitor has had.
owner_idstringThe id of the admin that owns the Visitor.
unsubscribed_from_emailsbooleanWhether the Visitor is unsubscribed from emails.
marked_email_as_spambooleanIdentifies if this visitor has marked an email as spam.
has_hard_bouncedbooleanIdentifies if this visitor has had a hard bounce.
custom_attributesobjectThe custom attributes you have set on the Visitor.
referrerstringThe referer of the visitor.
utm_campaignstringThe utm_campaign of the visitor.
utm_contentstringThe utm_content of the visitor.
utm_mediumstringThe utm_medium of the visitor.
utm_sourcestringThe utm_source of the visitor.
utm_termstringThe utm_term of the visitor.
do_not_trackbooleanIdentifies if this visitor has do not track enabled.