Check for Duplicate Company Contacts

Check whether a company contact already exists before adding or updating it.

Request URL

POST {base_url}/uc-ccontact/api/v1/company-contacts/check-duplicate

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
phones No Array<String> The phone numbers to check for duplicates.
Note: Up to 9 phone numbers are supported.
firstName No String The first name of the contact to check for duplicates.
lastName No String The last name of the contact to check for duplicates.
excludeId No String The ID of an existing contact to exclude from the duplicate check.
Note: You can obtain the ID using the Search Company Contacts interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Duplicate_Check_Result> The duplicate check result.
Duplicate_Check_Result
Parameter Type Description
items Array<Duplicate_Item> The list of duplicate contacts.
Duplicate_Item
Parameter Type Description
contactId String The ID of the duplicate contact.
firstName String The contact's first name.
lastName String The contact's last name.
mobilePhone String The contact's primary mobile phone number.
businessPhone String The contact's primary business phone number.
homePhone String The contact's primary home phone number.
businessFax String The contact's primary business fax number.
homeFax String The contact's primary home fax number.
mobile2Phone String The contact's secondary mobile phone number.
business2Phone String The contact's secondary business phone number.
home2Phone String The contact's secondary home phone number.
otherPhone String The contact's additional phone number.
matchType Integer The type of match found for the duplicate contact.
  • 1: Matched by name only.
  • 2: Matched by phone number only.
  • 3: Matched by both name and phone number.
contactName String The display name of the contact.

Example

Request example

POST /uc-ccontact/api/v1/company-contacts/check-duplicate HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTU1NjIyNywiaWF0IjoxNzkxNTM0NjI3LCJqdGkiOiI1OGIyYTM3YS1kM2Q2LTRhYTUtODEwOS1kZTg5ZGE3YTQ5NWMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.z9-FUkQL_rpNNUHl9ddimwioABpVsvQIF403CoYsR8OATIkbpWbxQXDpRD2ydJpkj_6FCqWxee7XjAswlUcn3YMWLo1HeuXFF3TnyS5diTmrAmd4_AL1S3S38pmY4sbgjVFLbZphx85V-HZ35ngZoHkNiyEoondYhF4eyE3SuXgnDRd3PQB-pD5QNzqortzvMAVXlzcTQvTG2OFKvQDVySyFigu0kK35EiL-A1PaBzQCrR768WG-Myk3R6T_Ae1p5IsB3zM0pBs0b_VI6qloo596Hq-yB3GFeCMMGpujTjIa7pk51mzgoOGwcYih8Q5klojv_t0SyoNbxJxXDMVNVw
Content-Type: application/json
x-tenant-code: jint
{
  "firstName": "zz",
  "lastName": "CompanyTest",
  "phones": [
    "+8613800138000"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "67ebd8ab650a03e62684ca45fb8fc9a8",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "items": [
      {
        "contactId": "366859309270061056",
        "firstName": "zz",
        "lastName": "CompanyTest",
        "mobilePhone": "+8613800138000",
        "businessPhone": "",
        "homePhone": "",
        "businessFax": "",
        "homeFax": "",
        "mobile2Phone": "",
        "business2Phone": "",
        "home2Phone": "",
        "otherPhone": "",
        "matchType": 3,
        "contactName": "zz CompanyTest"
      }
    ]
  }
}