The intercom API reference.
The intercom API reference.
Update an existing visitor.
A unique identified for the visitor which is given by Intercom.
"8a88a590-e"
curl -i -X PUT \ https://api.intercom.io/visitors \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.11' \ -d '{ "id": "667d61cc8a68186f43bafe95", "name": "Gareth Bale" }'
{ "type": "visitor", "id": "667d61cc8a68186f43bafe95", "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", "anonymous": true, "email": "", "phone": null, "name": "Gareth Bale", "pseudonym": "Indigo Ghost", "avatar": { "type": "avatar", "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" }, "app_id": "this_is_an_id671_that_should_be_at_least_", "companies": { "type": "company.list", "companies": [] }, "location_data": {}, "last_request_at": null, "created_at": 1719493068, "remote_created_at": 1719493068, "signed_up_at": 1719493068, "updated_at": 1719493068, "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 }
curl -i -X GET \ 'https://api.intercom.io/visitors?user_id=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.11'
{ "type": "visitor", "id": "667d61ce8a68186f43bafe9b", "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", "anonymous": true, "email": "", "phone": null, "name": null, "pseudonym": null, "avatar": { "type": "avatar", "image_url": null }, "app_id": "this_is_an_id677_that_should_be_at_least_", "companies": { "type": "company.list", "companies": [] }, "location_data": {}, "last_request_at": null, "created_at": 1719493070, "remote_created_at": 1719493070, "signed_up_at": 1719493070, "updated_at": 1719493070, "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 }
You can merge a Visitor to a Contact of role type lead
or user
.
📘 What happens upon a visitor being converted?
If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.
The unique identifiers retained after converting or merging.
The unique identifiers retained after converting or merging.
The unique identifier for the contact which is given by Intercom.
"8a88a590-e1c3-41e2-a502-e0649dbf721c"
A unique identifier for the contact which is given to Intercom, which will be represented as external_id.
"8a88a590-e1c3-41e2-a502-e0649dbf721c"
The unique identifiers to convert a single Visitor.
The unique identifiers to convert a single Visitor.
The unique identifier for the contact which is given by Intercom.
"8a88a590-e1c3-41e2-a502-e0649dbf721c"
A unique identifier for the contact which is given to Intercom.
"8a88a590-e1c3-41e2-a502-e0649dbf721c"