Home
/
REST API Reference
/
Visitors
/
Update a visitor

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.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "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" "Unstable"
Example: 2.10
Request Body schema: application/json
Any of:

Update an existing visitor.

id
required
string

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

user_id
string

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

name
string

The visitor's name.

object

The custom attributes which are set for the visitor.

put
/visitors
Request samples
application/json
{
"id": "660e73c36abd01bd27af623d",
"name": "Gareth Bale"
}
Responses

200

successful

Response Schema: application/json
type
string
Default: "visitor"

Value is 'visitor'

id
string

The Intercom defined id representing the Visitor.

user_id
string

Automatically generated identifier for the Visitor.

anonymous
boolean

Identifies if this visitor is anonymous.

email
string <email>

The email of the visitor.

phone
string or null

The phone number of the visitor.

name
string or null

The name of the visitor.

pseudonym
string or null

The pseudonym of the visitor.

object
app_id
string

The id of the app the visitor is associated with.

object
object
las_request_at
integer

The time the Lead last recorded making a request.

created_at
integer

The time the Visitor was added to Intercom.

remote_created_at
integer

The time the Visitor was added to Intercom.

signed_up_at
integer

The time the Visitor signed up for your product.

updated_at
integer

The last time the Visitor was updated.

session_count
integer

The number of sessions the Visitor has had.

object
owner_id
string or null

The id of the admin that owns the Visitor.

unsubscribed_from_emails
boolean

Whether the Visitor is unsubscribed from emails.

marked_email_as_spam
boolean

Identifies if this visitor has marked an email as spam.

has_hard_bounced
boolean

Identifies if this visitor has had a hard bounce.

object
object
object

The custom attributes you have set on the Visitor.

referrer
string or null

The referer of the visitor.

utm_campaign
string or null

The utm_campaign of the visitor.

utm_content
string or null

The utm_content of the visitor.

utm_medium
string or null

The utm_medium of the visitor.

utm_source
string or null

The utm_source of the visitor.

utm_term
string or null

The utm_term of the visitor.

do_not_track
boolean or null

Identifies if this visitor has do not track enabled.

401

Unauthorized

404

visitor Not Found

Response samples
application/json
{
"type": "visitor",
"id": "660e73c36abd01bd27af623d",
"user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3",
"anonymous": true,
"email": "",
"phone": null,
"name": "Gareth Bale",
"pseudonym": "Silver Basketball",
"avatar": {
"type": "avatar",
"image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/silver-basketball.png"
},
"app_id": "this_is_an_id646_that_should_be_at_least_",
"companies": {
"type": "company.list",
"companies": [ ]
},
"location_data": { },
"last_request_at": null,
"created_at": 1712223171,
"remote_created_at": 1712223171,
"signed_up_at": 1712223171,
"updated_at": 1712223171,
"session_count": 0,
"social_profiles": {
"type": "social_profile.list",
"social_profiles": [ ]
},
"owner_id": null,
"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": { },
"referrer": null,
"utm_campaign": null,
"utm_content": null,
"utm_medium": null,
"utm_source": null,
"utm_term": null,
"do_not_track": null
}