Update Visitor Request Payload

REST API Reference

Update an existing visitor.

Any of:

Update an existing visitor.

idstring

A unique identified for the visitor which is given by Intercom. Used to look the visitor up; it is not changed by this request.

Example:"8a88a590-e"

user_idstring

A unique identified for the visitor which is given by you. Used to look the visitor up; it is not changed by this request.

Example:"123"

namestring

The visitor's name.

Example:"Christian Bale"

emailstring

The visitor's email address. Sending this promotes the visitor to a lead and the response becomes a contact object.

Example:"winstonsmith@truth.org"

phonestring

The visitor's phone number.

Example:"+353871234567"

owner_idinteger

The id of the teammate who owns the visitor.

Example:991267734

last_request_atinteger

The time the visitor was last seen, as a Unix timestamp.

Example:1663597223

last_seen_ipstring

The IP address the visitor was last seen from.

Example:"1.2.3.4"

last_seen_user_agentstring

The user agent the visitor was last seen with.

Example:"Mozilla/5.0"

unsubscribed_from_emailsboolean

Whether the visitor is unsubscribed from emails.

Example:false

language_overridestring

The language to send the visitor messages in, overriding the language we detect.

Example:"fr"

avatarstring

An image URL for the visitor's avatar.

Example:"https://example.org/128Wu8Q.jpg"

companiesArray of objects

The companies to associate the visitor with. Only applied when the same request sends email, which promotes the visitor to a lead.

utm_campaignstring

The campaign the visitor arrived from.

Example:"intercom-link"

utm_contentstring

The content the visitor arrived from.

Example:"banner"

utm_mediumstring

The medium the visitor arrived from.

Example:"email"

utm_sourcestring

The source the visitor arrived from.

Example:"Intercom"

utm_termstring

The search term the visitor arrived from.

Example:"messenger"

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",
  "email": "winstonsmith@truth.org",
  "phone": "+353871234567",
  "owner_id": 991267734,
  "last_request_at": 1663597223,
  "last_seen_ip": "1.2.3.4",
  "last_seen_user_agent": "Mozilla/5.0",
  "unsubscribed_from_emails": false,
  "language_override": "fr",
  "avatar": "https://example.org/128Wu8Q.jpg",
  "companies": [
    {}
  ],
  "utm_campaign": "intercom-link",
  "utm_content": "banner",
  "utm_medium": "email",
  "utm_source": "Intercom",
  "utm_term": "messenger",
  "custom_attributes": {
    "paid_subscriber": true,
    "monthly_spend": 155.5,
    "team_mates": 9
  }
}