Save property access
curl --request PUT \
--url https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"record": {
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": true,
"givesAccess": true,
"emergencyContact": true,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": true,
"keysafeLocation": "<string>"
}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
record: {
contacts: [
{
contactId: '<string>',
reportsRepairs: true,
givesAccess: true,
emergencyContact: true,
availability: '<string>'
}
],
accessNotes: '<string>',
parkingAndHazards: '<string>',
keysafe: true,
keysafeLocation: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"record": {
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": True,
"givesAccess": True,
"emergencyContact": True,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": True,
"keysafeLocation": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"revision": 123,
"record": {
"mode": "occupied",
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": true,
"givesAccess": true,
"emergencyContact": true,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": true,
"keysafeLocation": "<string>",
"priorityNeeds": "not_asked"
},
"reachableContactIds": [
"<string>"
],
"keySets": 123,
"noAccess": [
{
"repairId": "<string>",
"reference": "<string>",
"visitStartsAt": "<string>",
"note": "<string>"
}
],
"updatedAt": "<string>",
"canEdit": true
}{
"_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>"
}maintenance-pro
Save property access
Save a property’s access and contacts at the revision read (idempotent on requestId)
PUT
/
maintenance-pro
/
properties
/
{propertyId}
/
access
Save property access
curl --request PUT \
--url https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"record": {
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": true,
"givesAccess": true,
"emergencyContact": true,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": true,
"keysafeLocation": "<string>"
}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
record: {
contacts: [
{
contactId: '<string>',
reportsRepairs: true,
givesAccess: true,
emergencyContact: true,
availability: '<string>'
}
],
accessNotes: '<string>',
parkingAndHazards: '<string>',
keysafe: true,
keysafeLocation: '<string>'
}
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/access"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"record": {
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": True,
"givesAccess": True,
"emergencyContact": True,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": True,
"keysafeLocation": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"revision": 123,
"record": {
"mode": "occupied",
"contacts": [
{
"contactId": "<string>",
"reportsRepairs": true,
"givesAccess": true,
"emergencyContact": true,
"availability": "<string>"
}
],
"accessNotes": "<string>",
"parkingAndHazards": "<string>",
"keysafe": true,
"keysafeLocation": "<string>",
"priorityNeeds": "not_asked"
},
"reachableContactIds": [
"<string>"
],
"keySets": 123,
"noAccess": [
{
"repairId": "<string>",
"reference": "<string>",
"visitStartsAt": "<string>",
"note": "<string>"
}
],
"updatedAt": "<string>",
"canEdit": true
}{
"_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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Path Parameters
Body
application/json