Save property setup
curl --request PUT \
--url https://api.sortx.co.uk/properties/{id}/setup \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"addresses": [
{
"id": "<string>",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": true,
"parties": [
{
"id": "<string>",
"contactId": "<string>",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [
{}
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
addresses: [
{
id: '<string>',
line1: '<string>',
line2: '<string>',
town: '<string>',
postcode: '<string>',
note: '<string>'
}
],
accessSameAsPostal: true,
parties: [
{
id: '<string>',
contactId: '<string>',
shareBps: 123,
fromOn: '<string>',
speaksForContactId: '<string>',
note: '<string>'
}
],
responsibilities: [{}]
})
};
fetch('https://api.sortx.co.uk/properties/{id}/setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/properties/{id}/setup"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"addresses": [
{
"id": "<string>",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": True,
"parties": [
{
"id": "<string>",
"contactId": "<string>",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [{}]
}
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,
"addresses": [
{
"id": "<string>",
"purpose": "contractor_access",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": true,
"parties": [
{
"id": "<string>",
"role": "co_owner",
"contactId": "<string>",
"interest": "freehold",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [
{
"part": "inside",
"responsible": "landlord",
"instructs": "agency",
"pays": "landlord"
}
],
"recorded": true,
"leasehold": true,
"landlordContactId": "<string>",
"block": {
"id": "<string>",
"name": "<string>",
"freeholderContactId": "<string>",
"managingAgentContactId": "<string>"
},
"updatedAt": "<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>"
}properties
Save property setup
Save a property’s addresses, owners and who repairs what, at the revision read (idempotent on requestId)
PUT
/
properties
/
{id}
/
setup
Save property setup
curl --request PUT \
--url https://api.sortx.co.uk/properties/{id}/setup \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"addresses": [
{
"id": "<string>",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": true,
"parties": [
{
"id": "<string>",
"contactId": "<string>",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [
{}
]
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
addresses: [
{
id: '<string>',
line1: '<string>',
line2: '<string>',
town: '<string>',
postcode: '<string>',
note: '<string>'
}
],
accessSameAsPostal: true,
parties: [
{
id: '<string>',
contactId: '<string>',
shareBps: 123,
fromOn: '<string>',
speaksForContactId: '<string>',
note: '<string>'
}
],
responsibilities: [{}]
})
};
fetch('https://api.sortx.co.uk/properties/{id}/setup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/properties/{id}/setup"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"addresses": [
{
"id": "<string>",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": True,
"parties": [
{
"id": "<string>",
"contactId": "<string>",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [{}]
}
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,
"addresses": [
{
"id": "<string>",
"purpose": "contractor_access",
"line1": "<string>",
"line2": "<string>",
"town": "<string>",
"postcode": "<string>",
"note": "<string>"
}
],
"accessSameAsPostal": true,
"parties": [
{
"id": "<string>",
"role": "co_owner",
"contactId": "<string>",
"interest": "freehold",
"shareBps": 123,
"fromOn": "<string>",
"speaksForContactId": "<string>",
"note": "<string>"
}
],
"responsibilities": [
{
"part": "inside",
"responsible": "landlord",
"instructs": "agency",
"pays": "landlord"
}
],
"recorded": true,
"leasehold": true,
"landlordContactId": "<string>",
"block": {
"id": "<string>",
"name": "<string>",
"freeholderContactId": "<string>",
"managingAgentContactId": "<string>"
},
"updatedAt": "<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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Path Parameters
Body
application/json
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes