Set void work blocked
curl --request POST \
--url https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked"
payload = { "note": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"today": "<string>",
"void": {
"id": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"label": "<string>",
"sourceTenancyId": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"emptySince": "<string>",
"days": 123,
"targetReadyOn": "<string>",
"late": true,
"stage": "inspection",
"stageIndex": 123,
"stageLabel": "<string>",
"status": "open",
"outcome": "let",
"outcomeLabel": "<string>",
"closedOn": "<string>",
"closedAt": "<string>",
"closedByUserId": "<string>",
"holdingUpNote": "<string>",
"holdingUp": "<string>",
"budget": {
"committedMinor": 123,
"approvedMinor": 123,
"leftMinor": 123,
"over": true,
"overByMinor": 123,
"percent": 123
},
"works": [
{
"repairId": "<string>",
"reference": "<string>",
"title": "<string>",
"kind": "<string>",
"purpose": "works",
"contractorName": "<string>",
"status": "awaiting_quote",
"statusLabel": "<string>",
"costMinor": 123,
"blockedNote": "<string>",
"visitOn": "<string>"
}
],
"taskCount": 123,
"openTaskCount": 123,
"checks": [
{
"check": "works_done",
"label": "<string>",
"state": "pass",
"note": "<string>",
"manual": true
}
],
"checksPassed": 123,
"checksTotal": 123,
"readyToLet": true,
"landlordAsk": {
"repairId": "<string>",
"amountMinor": 123,
"askedAt": "<string>",
"approved": true
},
"revision": 123
},
"stageHistory": [
{
"stage": "inspection",
"label": "<string>",
"enteredOn": "<string>",
"actorUserId": "<string>"
}
],
"stageDays": {
"inspection": 123,
"works": 123,
"clean": 123,
"compliance": 123,
"ready": 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>"
}handovers
Set void work blocked
Mark a void’s job Blocked with the reason (null clears it); the reason shows as what is holding the void up
POST
/
handovers
/
voids
/
{id}
/
works
/
{repairId}
/
blocked
Set void work blocked
curl --request POST \
--url https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/handovers/voids/{id}/works/{repairId}/blocked"
payload = { "note": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"today": "<string>",
"void": {
"id": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"label": "<string>",
"sourceTenancyId": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"emptySince": "<string>",
"days": 123,
"targetReadyOn": "<string>",
"late": true,
"stage": "inspection",
"stageIndex": 123,
"stageLabel": "<string>",
"status": "open",
"outcome": "let",
"outcomeLabel": "<string>",
"closedOn": "<string>",
"closedAt": "<string>",
"closedByUserId": "<string>",
"holdingUpNote": "<string>",
"holdingUp": "<string>",
"budget": {
"committedMinor": 123,
"approvedMinor": 123,
"leftMinor": 123,
"over": true,
"overByMinor": 123,
"percent": 123
},
"works": [
{
"repairId": "<string>",
"reference": "<string>",
"title": "<string>",
"kind": "<string>",
"purpose": "works",
"contractorName": "<string>",
"status": "awaiting_quote",
"statusLabel": "<string>",
"costMinor": 123,
"blockedNote": "<string>",
"visitOn": "<string>"
}
],
"taskCount": 123,
"openTaskCount": 123,
"checks": [
{
"check": "works_done",
"label": "<string>",
"state": "pass",
"note": "<string>",
"manual": true
}
],
"checksPassed": 123,
"checksTotal": 123,
"readyToLet": true,
"landlordAsk": {
"repairId": "<string>",
"amountMinor": 123,
"askedAt": "<string>",
"approved": true
},
"revision": 123
},
"stageHistory": [
{
"stage": "inspection",
"label": "<string>",
"enteredOn": "<string>",
"actorUserId": "<string>"
}
],
"stageDays": {
"inspection": 123,
"works": 123,
"clean": 123,
"compliance": 123,
"ready": 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>"
}