Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Visitors

Update a visitor

Sending a PUT request to /visitors will result in an update of an existing Visitor.

Option 1. You can update a visitor by passing in the user_id of the visitor in the Request body.

Option 2. You can update a visitor by passing in the id of the visitor in the Request body.

put/visitors

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

OR

Example request

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

Response

successful

typestring

Value is 'visitor'

idstring

The Intercom defined id representing the Visitor.

user_idstring

Automatically generated identifier for the Visitor.

anonymousboolean

Identifies if this visitor is anonymous.

emailstring email

The email of the visitor.

phonestring nullable

The phone number of the visitor.

namestring nullable

The name of the visitor.

pseudonymstring nullable

The pseudonym of the visitor.

app_idstring

The id of the app the visitor is associated with.

las_request_atinteger

The time the Lead last recorded making a request.

created_atinteger

The time the Visitor was added to Intercom.

remote_created_atinteger

The time the Visitor was added to Intercom.

signed_up_atinteger

The time the Visitor signed up for your product.

updated_atinteger

The last time the Visitor was updated.

session_countinteger

The number of sessions the Visitor has had.

owner_idstring nullable

The id of the admin that owns the Visitor.

unsubscribed_from_emailsboolean

Whether the Visitor is unsubscribed from emails.

marked_email_as_spamboolean

Identifies if this visitor has marked an email as spam.

has_hard_bouncedboolean

Identifies if this visitor has had a hard bounce.

custom_attributesobject

The custom attributes you have set on the Visitor.

referrerstring nullable

The referer of the visitor.

utm_campaignstring nullable

The utm_campaign of the visitor.

utm_contentstring nullable

The utm_content of the visitor.

utm_mediumstring nullable

The utm_medium of the visitor.

utm_sourcestring nullable

The utm_source of the visitor.

utm_termstring nullable

The utm_term of the visitor.

do_not_trackboolean nullable

Identifies if this visitor has do not track enabled.

Example response

{
  "type": "visitor",
  "id": "530370b477ad7120001d",
  "user_id": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
  "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": [
      {
        "type": "company",
        "id": "531ee472cce572a6ec000006",
        "name": "Blue Sun",
        "app_id": "ecahpwf5",
        "plan": {
          "type": "plan",
          "id": "269315",
          "name": "Pro"
        },
        "company_id": "6",
        "remote_created_at": 1663597223,
        "created_at": 1663597223,
        "updated_at": 1663597223,
        "last_request_at": 1663597223,
        "size": 100,
        "website": "https://www.intercom.com",
        "industry": "Software",
        "monthly_spend": 100,
        "session_count": 100,
        "user_count": 100,
        "custom_attributes": {
          "paid_subscriber": true,
          "monthly_spend": 155.5,
          "team_mates": 9
        },
        "tags": {
          "tags": [
            {
              "type": "tag",
              "id": "123456",
              "name": "Test tag"
            }
          ]
        },
        "segments": {
          "segments": [
            {
              "type": "segment",
              "id": "56203d253cba154d39010062",
              "name": "Active",
              "created_at": 1394621988,
              "updated_at": 1394622004,
              "person_type": "contact",
              "count": 3
            }
          ]
        }
      }
    ]
  },
  "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"
  },
  "owner_id": "5169261",
  "tags": {
    "type": "tag.list",
    "tags": [
      {
        "type": "tag",
        "id": "8482",
        "name": "tag_name"
      }
    ]
  },
  "segments": {
    "type": "segment.list"
  },
  "referrer": "https://www.google.com/",
  "utm_campaign": "intercom-link",
  "utm_content": "banner",
  "utm_medium": "email",
  "utm_source": "Intercom",
  "utm_term": "messenger"
}