Duplicate check
curl --request POST \
--url https://api.sortx.co.uk/contacts/duplicate-check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"kind": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"registrationNumber": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
kind: '<string>',
email: '<string>',
mobile: '<string>',
addressPostcode: '<string>',
registrationNumber: '<string>'
})
};
fetch('https://api.sortx.co.uk/contacts/duplicate-check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contacts/duplicate-check"
payload = {
"name": "<string>",
"kind": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"registrationNumber": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"candidates": [
{
"contact": {
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"roles": [
"<string>"
],
"archivedAt": "<string>"
},
"matchedOn": [
"email"
],
"exact": true,
"conflicting": [
"<string>"
]
}
],
"totalMatched": 123,
"truncated": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}contacts
Duplicate check
Existing records a draft contact may duplicate; nothing is written
POST
/
contacts
/
duplicate-check
Duplicate check
curl --request POST \
--url https://api.sortx.co.uk/contacts/duplicate-check \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"kind": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"registrationNumber": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
kind: '<string>',
email: '<string>',
mobile: '<string>',
addressPostcode: '<string>',
registrationNumber: '<string>'
})
};
fetch('https://api.sortx.co.uk/contacts/duplicate-check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contacts/duplicate-check"
payload = {
"name": "<string>",
"kind": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"registrationNumber": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"candidates": [
{
"contact": {
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"email": "<string>",
"mobile": "<string>",
"addressPostcode": "<string>",
"roles": [
"<string>"
],
"archivedAt": "<string>"
},
"matchedOn": [
"email"
],
"exact": true,
"conflicting": [
"<string>"
]
}
],
"totalMatched": 123,
"truncated": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Body
application/json