Update a Visitor
Example Request
$ curl https://api.intercom.io/visitors \
-XPUT \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' -d '
{
"user_id": "124",
"name": "Joe Example",
"custom_attributes": {
"paid_subscriber" : true,
"monthly_spend": 155.5,
"team_mates": 9
}
}'
HTTP/1.1 200 OK
{
"type": "visitor",
"id": "573479f784c5acde6a000575",
"user_id": "16e690c0-485a-4e87-ae98-a326e788a4f7",
"email": "joe@example.com",
"name": "Joe Example",
...
}
# NB: Full Visitor objects are returned
visitor.name = "Joe Example"
visitor.custom_attribute[:foo] = 'bar'
intercom.visitors.save(visitor)
Sending a PUT request to /visitors
and passing identifiers (user_id or id) in the body will result in an update of an existing Visitor.
It is not possible to uniquely identify a Visitor for an update with an email address. Including an email address in the PUT request will result in converting the Visitor to a Lead.