Update directory details
curl --request PATCH \
--url https://api.sortx.co.uk/contractor-directory/{contactId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": true,
"preferredSince": "<string>",
"dayRateMinor": 123,
"officePhone": "<string>",
"jobsEmail": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamSize: 123,
teamNoun: '<string>',
summary: '<string>',
employsStaff: true,
preferredSince: '<string>',
dayRateMinor: 123,
officePhone: '<string>',
jobsEmail: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractor-directory/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-directory/{contactId}"
payload = {
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": True,
"preferredSince": "<string>",
"dayRateMinor": 123,
"officePhone": "<string>",
"jobsEmail": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"headline": "<string>",
"subline": "<string>",
"trades": [
"<string>"
],
"areas": "<string>",
"preferredSince": "<string>",
"stats": {
"jobs12mo": 123,
"onTimePct": 123,
"firstFixPct": 123,
"respondsHours": 123,
"rating": 123,
"ratedJobs": 123
},
"compliance": {
"tone": "ok",
"label": "<string>",
"credentialId": "<string>"
},
"documents": [
{
"credentialId": "<string>",
"kind": "<string>",
"label": "<string>",
"tone": "ok",
"pill": "<string>",
"expiresOn": "<string>",
"verified": true,
"documentId": "<string>"
}
],
"contact": {
"office": "<string>",
"jobsInbox": "<string>",
"dayRateMinor": 123,
"ratesNotes": "<string>"
},
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": true,
"emergencyCallouts": true,
"revision": 123
}{
"_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
Update directory details
Change a contractor’s team, summary, preferred-since, day rate, office phone or jobs inbox
PATCH
/
contractor-directory
/
{contactId}
Update directory details
curl --request PATCH \
--url https://api.sortx.co.uk/contractor-directory/{contactId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": true,
"preferredSince": "<string>",
"dayRateMinor": 123,
"officePhone": "<string>",
"jobsEmail": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
teamSize: 123,
teamNoun: '<string>',
summary: '<string>',
employsStaff: true,
preferredSince: '<string>',
dayRateMinor: 123,
officePhone: '<string>',
jobsEmail: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractor-directory/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-directory/{contactId}"
payload = {
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": True,
"preferredSince": "<string>",
"dayRateMinor": 123,
"officePhone": "<string>",
"jobsEmail": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"headline": "<string>",
"subline": "<string>",
"trades": [
"<string>"
],
"areas": "<string>",
"preferredSince": "<string>",
"stats": {
"jobs12mo": 123,
"onTimePct": 123,
"firstFixPct": 123,
"respondsHours": 123,
"rating": 123,
"ratedJobs": 123
},
"compliance": {
"tone": "ok",
"label": "<string>",
"credentialId": "<string>"
},
"documents": [
{
"credentialId": "<string>",
"kind": "<string>",
"label": "<string>",
"tone": "ok",
"pill": "<string>",
"expiresOn": "<string>",
"verified": true,
"documentId": "<string>"
}
],
"contact": {
"office": "<string>",
"jobsInbox": "<string>",
"dayRateMinor": 123,
"ratesNotes": "<string>"
},
"teamSize": 123,
"teamNoun": "<string>",
"summary": "<string>",
"employsStaff": true,
"emergencyCallouts": true,
"revision": 123
}{
"_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
Body
application/json
Response
Success