provider Visitors POST /visitors/convert
@utdk/intercom /visitors/convert
Convert a visitor
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.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

convertvisitor
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.

Input

required

Represents the role of the Contact model. Accepts `lead` or `user`.

required

The unique identifiers retained after converting or merging.

required

The unique identifiers to convert a single Visitor.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.convertvisitor({
  "Intercom-Version": "2.14"
})