Onboard property
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/properties/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"uprn": "<string>"
},
"beds": 0,
"occupierContactId": "<string>",
"rooms": [
{
"name": "<string>",
"occupierContactId": "<string>"
}
],
"occupiedFrom": "<string>",
"landlordContactId": "<string>",
"landlordCompanyId": "<string>",
"owners": [
{
"contactId": "<string>",
"sharePercent": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>"
}
],
"responsibilities": [
{
"otherName": "<string>"
}
],
"repairAuthority": {
"standardLimitPounds": 123,
"emergency": {
"limitPounds": 123
},
"statutory": {
"limitPounds": 123
},
"approverContactId": "<string>"
},
"emailLandlordToConfirm": true
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
address: {
line1: '<string>',
line2: '<string>',
town: '<string>',
postcode: '<string>',
uprn: '<string>'
},
beds: 0,
occupierContactId: '<string>',
rooms: [{name: '<string>', occupierContactId: '<string>'}],
occupiedFrom: '<string>',
landlordContactId: '<string>',
landlordCompanyId: '<string>',
owners: [
{
contactId: '<string>',
sharePercent: 123,
fromOn: '<string>',
speaksForContactId: '<string>'
}
],
responsibilities: [{otherName: '<string>'}],
repairAuthority: {
standardLimitPounds: 123,
emergency: {limitPounds: 123},
statutory: {limitPounds: 123},
approverContactId: '<string>'
},
emailLandlordToConfirm: true
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/onboard', 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/onboard"
payload = {
"requestId": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"uprn": "<string>"
},
"beds": 0,
"occupierContactId": "<string>",
"rooms": [
{
"name": "<string>",
"occupierContactId": "<string>"
}
],
"occupiedFrom": "<string>",
"landlordContactId": "<string>",
"landlordCompanyId": "<string>",
"owners": [
{
"contactId": "<string>",
"sharePercent": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>"
}
],
"responsibilities": [{ "otherName": "<string>" }],
"repairAuthority": {
"standardLimitPounds": 123,
"emergency": { "limitPounds": 123 },
"statutory": { "limitPounds": 123 },
"approverContactId": "<string>"
},
"emailLandlordToConfirm": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"units": [
{
"id": "<string>",
"label": "<string>",
"roomType": "single",
"furnishing": "unfurnished",
"tenancyId": "<string>"
}
],
"setupRevision": 123,
"repairAuthority": {
"authorityId": "<string>",
"versionId": "<string>",
"revision": 123,
"summary": [
"<string>"
]
},
"confirmation": {
"requested": true,
"sent": true,
"sentTo": "<string>",
"landlordName": "<string>",
"expiresAt": "<string>",
"reason": "<string>"
},
"replayed": 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
Onboard property
Add a property from the New property wizard in one go: the property and its rooms, its owners, who repairs what, a repair authority draft and the occupiers’ tenancies; optionally email the landlord a link to confirm the limits (idempotent on requestId)
POST
/
maintenance-pro
/
properties
/
onboard
Onboard property
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/properties/onboard \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"uprn": "<string>"
},
"beds": 0,
"occupierContactId": "<string>",
"rooms": [
{
"name": "<string>",
"occupierContactId": "<string>"
}
],
"occupiedFrom": "<string>",
"landlordContactId": "<string>",
"landlordCompanyId": "<string>",
"owners": [
{
"contactId": "<string>",
"sharePercent": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>"
}
],
"responsibilities": [
{
"otherName": "<string>"
}
],
"repairAuthority": {
"standardLimitPounds": 123,
"emergency": {
"limitPounds": 123
},
"statutory": {
"limitPounds": 123
},
"approverContactId": "<string>"
},
"emailLandlordToConfirm": true
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
address: {
line1: '<string>',
line2: '<string>',
town: '<string>',
postcode: '<string>',
uprn: '<string>'
},
beds: 0,
occupierContactId: '<string>',
rooms: [{name: '<string>', occupierContactId: '<string>'}],
occupiedFrom: '<string>',
landlordContactId: '<string>',
landlordCompanyId: '<string>',
owners: [
{
contactId: '<string>',
sharePercent: 123,
fromOn: '<string>',
speaksForContactId: '<string>'
}
],
responsibilities: [{otherName: '<string>'}],
repairAuthority: {
standardLimitPounds: 123,
emergency: {limitPounds: 123},
statutory: {limitPounds: 123},
approverContactId: '<string>'
},
emailLandlordToConfirm: true
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/onboard', 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/onboard"
payload = {
"requestId": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"uprn": "<string>"
},
"beds": 0,
"occupierContactId": "<string>",
"rooms": [
{
"name": "<string>",
"occupierContactId": "<string>"
}
],
"occupiedFrom": "<string>",
"landlordContactId": "<string>",
"landlordCompanyId": "<string>",
"owners": [
{
"contactId": "<string>",
"sharePercent": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>"
}
],
"responsibilities": [{ "otherName": "<string>" }],
"repairAuthority": {
"standardLimitPounds": 123,
"emergency": { "limitPounds": 123 },
"statutory": { "limitPounds": 123 },
"approverContactId": "<string>"
},
"emailLandlordToConfirm": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"propertyId": "<string>",
"units": [
{
"id": "<string>",
"label": "<string>",
"roomType": "single",
"furnishing": "unfurnished",
"tenancyId": "<string>"
}
],
"setupRevision": 123,
"repairAuthority": {
"authorityId": "<string>",
"versionId": "<string>",
"revision": 123,
"summary": [
"<string>"
]
},
"confirmation": {
"requested": true,
"sent": true,
"sentTo": "<string>",
"landlordName": "<string>",
"expiresAt": "<string>",
"reason": "<string>"
},
"replayed": 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
Body
application/json