Record job outcome
curl --request POST \
--url https://api.sortx.co.uk/contractors/{contactId}/job-outcomes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": true,
"firstFix": true,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repairId: '<string>',
title: '<string>',
finishedOn: '<string>',
onTime: true,
firstFix: true,
responseMinutes: 123,
rating: 123,
ratingNote: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractors/{contactId}/job-outcomes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}/job-outcomes"
payload = {
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": True,
"firstFix": True,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"contactId": "<string>",
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": true,
"firstFix": true,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>",
"ratedByName": "<string>"
}{
"_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
Record job outcome
Record a finished job’s outcome or rate it (1 to 5); a second write for the same repair updates it
POST
/
contractors
/
{contactId}
/
job-outcomes
Record job outcome
curl --request POST \
--url https://api.sortx.co.uk/contractors/{contactId}/job-outcomes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": true,
"firstFix": true,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repairId: '<string>',
title: '<string>',
finishedOn: '<string>',
onTime: true,
firstFix: true,
responseMinutes: 123,
rating: 123,
ratingNote: '<string>'
})
};
fetch('https://api.sortx.co.uk/contractors/{contactId}/job-outcomes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}/job-outcomes"
payload = {
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": True,
"firstFix": True,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"contactId": "<string>",
"repairId": "<string>",
"title": "<string>",
"finishedOn": "<string>",
"onTime": true,
"firstFix": true,
"responseMinutes": 123,
"rating": 123,
"ratingNote": "<string>",
"ratedByName": "<string>"
}{
"_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