Property boards restore
curl --request POST \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"propertyId": "<string>",
"address": "<string>",
"line1": "<string>",
"postcode": "<string>",
"typeLine": "<string>",
"hmo": true,
"blockId": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"compliance": {
"tone": "ok",
"text": "<string>"
},
"openRepairs": 123,
"inspection": {
"nextDueOn": "<string>",
"overdue": true,
"label": "<string>"
},
"occupancy": "let",
"occupancyLabel": "<string>",
"filters": [
"all"
]
}{
"_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>"
}property-boards
Property boards restore
Bring an archived property back into the portfolio
POST
/
property-boards
/
properties
/
{propertyId}
/
restore
Property boards restore
curl --request POST \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/properties/{propertyId}/restore"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"propertyId": "<string>",
"address": "<string>",
"line1": "<string>",
"postcode": "<string>",
"typeLine": "<string>",
"hmo": true,
"blockId": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"compliance": {
"tone": "ok",
"text": "<string>"
},
"openRepairs": 123,
"inspection": {
"nextDueOn": "<string>",
"overdue": true,
"label": "<string>"
},
"occupancy": "let",
"occupancyLabel": "<string>",
"filters": [
"all"
]
}{
"_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
Response
Success