POST /visitors/convert
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.
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
visitor |
Object | Yes |
The unique identifiers to convert a single Visitor. |
visitor.id |
String | No |
The unique identifier for the contact which is given by Intercom. |
visitor.email |
String | No |
The visitor's email. |
visitor.user_id |
String | No |
A unique identifier for the contact which is given to Intercom. |
user |
Object | Yes |
The unique identifiers retained after converting or merging. |
user.id |
String | No |
The unique identifier for the contact which is given by Intercom. |
user.email |
String | No |
The contact's email, retained by default if one is present. |
user.user_id |
String | No |
A unique identifier for the contact which is given to Intercom, which will be represented as external_id. |
type |
String | Yes |
Represents the role of the Contact model. Accepts |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.