Get
/api/v1/omnichannel/contacts.checkExistence
This identifies whether a contact is already registered using a given query parameter such as email or phone or contactId.
Note: You must provide only one of the parameters in the request.
Required permission: view-livechat-contact.
Changelog
| Version | Description |
|---|---|
| 7.2.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
contactId
string
The contact's unique ID.
Example673c76df47a6c9b89dd263d8
email
string
The omnichannel contact's email address.
Example[email protected]
phone
string
Phone number of the omnichannel contact.
Example01234567843
Responses
200
OK
Contact found
{
"exists": true,
"success": true
}contact not found
{
"exists": false,
"success": true
}object
exists
boolean
success
boolean
400
Bad Request
Error from missing query parameters
{
"success": false,
"error": "must have required property 'contactId'\n must have required property 'email'\n must have required property 'phone'\n must match exactly one schema in oneOf [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string