Property boards archive
curl --request POST \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId}/archive \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}/archive', 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}/archive"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"address": "<string>",
"history": "<string>",
"repairs": 123,
"inspections": 123,
"lastLandlord": {
"contactId": "<string>",
"name": "<string>"
},
"archivedAt": "<string>",
"archivedLabel": "<string>",
"reason": "sold",
"reasonLabel": "<string>",
"files": 123,
"filesLabel": "<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>"
}property-boards
Property boards archive
Archive a property and say why (sold, landlord moved agent, landlord self-managing)
POST
/
property-boards
/
properties
/
{propertyId}
/
archive
Property boards archive
curl --request POST \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId}/archive \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}/archive', 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}/archive"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"address": "<string>",
"history": "<string>",
"repairs": 123,
"inspections": 123,
"lastLandlord": {
"contactId": "<string>",
"name": "<string>"
},
"archivedAt": "<string>",
"archivedLabel": "<string>",
"reason": "sold",
"reasonLabel": "<string>",
"files": 123,
"filesLabel": "<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
Response
Success