Add occupier
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/occupiers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"movedInOn": "<string>",
"unitId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"others": [
{
"firstName": "<string>",
"lastName": "<string>"
}
],
"email": "<string>",
"phone": "<string>",
"accessNeeds": [],
"contractorRisks": [],
"contractorNotes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
movedInOn: '<string>',
unitId: '<string>',
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
contactFirstName: '<string>',
contactLastName: '<string>',
others: [{firstName: '<string>', lastName: '<string>'}],
email: '<string>',
phone: '<string>',
accessNeeds: [],
contractorRisks: [],
contractorNotes: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/occupiers', 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}/occupiers"
payload = {
"movedInOn": "<string>",
"unitId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"others": [
{
"firstName": "<string>",
"lastName": "<string>"
}
],
"email": "<string>",
"phone": "<string>",
"accessNeeds": [],
"contractorRisks": [],
"contractorNotes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contactId": "<string>",
"companyId": "<string>",
"contactPersonId": "<string>",
"otherContactIds": [
"<string>"
],
"tenancyId": "<string>",
"unitId": "<string>",
"accessRevision": 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>"
}maintenance-pro
Add occupier
Add an occupier to a property or room: the people living there, the occupancy from the moved-in date, their needs, risks to contractors and how contractors get in
POST
/
maintenance-pro
/
properties
/
{propertyId}
/
occupiers
Add occupier
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/occupiers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"movedInOn": "<string>",
"unitId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"others": [
{
"firstName": "<string>",
"lastName": "<string>"
}
],
"email": "<string>",
"phone": "<string>",
"accessNeeds": [],
"contractorRisks": [],
"contractorNotes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
movedInOn: '<string>',
unitId: '<string>',
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
contactFirstName: '<string>',
contactLastName: '<string>',
others: [{firstName: '<string>', lastName: '<string>'}],
email: '<string>',
phone: '<string>',
accessNeeds: [],
contractorRisks: [],
contractorNotes: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/properties/{propertyId}/occupiers', 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}/occupiers"
payload = {
"movedInOn": "<string>",
"unitId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"others": [
{
"firstName": "<string>",
"lastName": "<string>"
}
],
"email": "<string>",
"phone": "<string>",
"accessNeeds": [],
"contractorRisks": [],
"contractorNotes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"contactId": "<string>",
"companyId": "<string>",
"contactPersonId": "<string>",
"otherContactIds": [
"<string>"
],
"tenancyId": "<string>",
"unitId": "<string>",
"accessRevision": 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>"
}Authorizations
Body
application/json