Visitor

Update Visitor Request Payload

Update an existing visitor.

Any of:

Update an existing visitor.

idstringrequired

A unique identified for the visitor which is given by Intercom.

Example: "8a88a590-e"

user_idstring

A unique identified for the visitor which is given by you.

Example: "123"

namestring

The visitor's name.

Example: "Christian Bale"

custom_attributesobject

The custom attributes which are set for the visitor.

Example: {"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}

{
  "id": "8a88a590-e",
  "user_id": "123",
  "name": "Christian Bale",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  }
}

Visitor

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.

typestring

Value is 'visitor'

Default "visitor"

Example: "visitor"

idstring

The Intercom defined id representing the Visitor.

Example: "530370b477ad7120001d"

user_idstring

Automatically generated identifier for the Visitor.

Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"

anonymousboolean

Identifies if this visitor is anonymous.

Example: false

emailstring(email)

The email of the visitor.

Example: "jane.doe@example.com"

phonestring or null

The phone number of the visitor.

Example: "555-555-5555"

namestring or null

The name of the visitor.

Example: "Jane Doe"

pseudonymstring or null

The pseudonym of the visitor.

Example: "Red Duck from Dublin"

avatarobject

app_idstring

The id of the app the visitor is associated with.

Example: "hfi1bx4l"

companiesobject

location_dataobject

las_request_atinteger

The time the Lead last recorded making a request.

Example: 1663597260

created_atinteger

The time the Visitor was added to Intercom.

Example: 1663597223

remote_created_atinteger

The time the Visitor was added to Intercom.

Example: 1663597223

signed_up_atinteger

The time the Visitor signed up for your product.

Example: 1663597223

updated_atinteger

The last time the Visitor was updated.

Example: 1663597260

session_countinteger

The number of sessions the Visitor has had.

Example: 1

social_profilesobject

owner_idstring or null

The id of the admin that owns the Visitor.

Example: "5169261"

unsubscribed_from_emailsboolean

Whether the Visitor is unsubscribed from emails.

Example: false

marked_email_as_spamboolean

Identifies if this visitor has marked an email as spam.

Example: false

has_hard_bouncedboolean

Identifies if this visitor has had a hard bounce.

Example: false

tagsobject

segmentsobject

custom_attributesobject

The custom attributes you have set on the Visitor.

referrerstring or null

The referer of the visitor.

Example: "https://www.google.com/"

utm_campaignstring or null

The utm_campaign of the visitor.

Example: "intercom-link"

utm_contentstring or null

The utm_content of the visitor.

Example: "banner"

utm_mediumstring or null

The utm_medium of the visitor.

Example: "email"

utm_sourcestring or null

The utm_source of the visitor.

Example: "Intercom"

utm_termstring or null

The utm_term of the visitor.

Example: "messenger"

do_not_trackboolean or null

Identifies if this visitor has do not track enabled.

Example: false

{
  "type": "visitor",
  "id": "530370b477ad7120001d",
  "user_id": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
  "anonymous": false,
  "email": "jane.doe@example.com",
  "phone": "555-555-5555",
  "name": "Jane Doe",
  "pseudonym": "Red Duck from Dublin",
  "avatar": {
    "type": "avatar",
    "image_url": "https://example.com/avatar.png"
  },
  "app_id": "hfi1bx4l",
  "companies": {
    "type": "company.list",
    "companies": [ … ]
  },
  "location_data": {
    "type": "location_data",
    "city_name": "Dublin",
    "continent_code": "EU",
    "country_code": "IRL",
    "country_name": "Ireland",
    "postal_code": "D02 N960",
    "region_name": "Leinster",
    "timezone": "Europe/Dublin"
  },
  "las_request_at": 1663597260,
  "created_at": 1663597223,
  "remote_created_at": 1663597223,
  "signed_up_at": 1663597223,
  "updated_at": 1663597260,
  "session_count": 1,
  "social_profiles": {
    "type": "social_profile.list",
    "social_profiles": [ … ]
  },
  "owner_id": "5169261",
  "unsubscribed_from_emails": false,
  "marked_email_as_spam": false,
  "has_hard_bounced": false,
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  },
  "segments": {
    "type": "segment.list",
    "segments": [ … ]
  },
  "custom_attributes": {
    "property1": "string",
    "property2": "string"
  },
  "referrer": "https://www.google.com/",
  "utm_campaign": "intercom-link",
  "utm_content": "banner",
  "utm_medium": "email",
  "utm_source": "Intercom",
  "utm_term": "messenger",
  "do_not_track": false
}

Visitor Deleted Object

Response returned when an object is deleted

idstring

The unique identifier for the visitor which is given by Intercom.

Example: "530370b477ad7120001d"

typestring

The type of object which was deleted

Value"visitor"

Example: "visitor"

user_idstring

Automatically generated identifier for the Visitor.

Example: "8a88a590-e1c3-41e2-a502-e0649dbf721c"

{
  "id": "530370b477ad7120001d",
  "type": "visitor",
  "user_id": "8a88a590-e1c3-41e2-a502-e0649dbf721c"
}

Intercom API (2.9)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Update Visitor Request Payload

Visitor

Visitor Deleted Object