Add prospect
curl --request POST \
--url https://api.sortx.co.uk/contractor-prospects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"externalId": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>",
"addressLine1": "<string>",
"town": "<string>",
"postcode": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"searchTrade": "<string>",
"searchPostcode": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
externalId: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
website: '<string>',
addressLine1: '<string>',
town: '<string>',
postcode: '<string>',
trades: ['<string>'],
coverageAreas: ['<string>'],
searchTrade: '<string>',
searchPostcode: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractor-prospects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-prospects"
payload = {
"requestId": "<string>",
"externalId": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>",
"addressLine1": "<string>",
"town": "<string>",
"postcode": "<string>",
"trades": ["<string>"],
"coverageAreas": ["<string>"],
"searchTrade": "<string>",
"searchPostcode": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contractor": {
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
}
},
"alreadyAdded": 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>"
}contractors
Add prospect
Add a business from a search as a prospect: never given work until a person activates it
POST
/
contractor-prospects
Add prospect
curl --request POST \
--url https://api.sortx.co.uk/contractor-prospects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"externalId": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>",
"addressLine1": "<string>",
"town": "<string>",
"postcode": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"searchTrade": "<string>",
"searchPostcode": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
externalId: '<string>',
name: '<string>',
phone: '<string>',
email: '<string>',
website: '<string>',
addressLine1: '<string>',
town: '<string>',
postcode: '<string>',
trades: ['<string>'],
coverageAreas: ['<string>'],
searchTrade: '<string>',
searchPostcode: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractor-prospects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-prospects"
payload = {
"requestId": "<string>",
"externalId": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"website": "<string>",
"addressLine1": "<string>",
"town": "<string>",
"postcode": "<string>",
"trades": ["<string>"],
"coverageAreas": ["<string>"],
"searchTrade": "<string>",
"searchPostcode": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contractor": {
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
}
},
"alreadyAdded": 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