Import addresses
curl --request POST \
--url https://api.sortx.co.uk/properties/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"rows": [
{
"line1": "<string>",
"postcode": "<string>",
"town": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({rows: [{line1: '<string>', postcode: '<string>', town: '<string>'}]})
};
fetch('https://api.sortx.co.uk/properties/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/properties/import"
payload = { "rows": [
{
"line1": "<string>",
"postcode": "<string>",
"town": "<string>"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"created": [
{
"id": "<string>",
"line1": "<string>",
"postcode": "<string>"
}
],
"skipped": [
{
"line1": "<string>",
"postcode": "<string>",
"reason": "<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
Import addresses
Add a list of addresses as properties; an address already on file is skipped
POST
/
properties
/
import
Import addresses
curl --request POST \
--url https://api.sortx.co.uk/properties/import \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"rows": [
{
"line1": "<string>",
"postcode": "<string>",
"town": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({rows: [{line1: '<string>', postcode: '<string>', town: '<string>'}]})
};
fetch('https://api.sortx.co.uk/properties/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/properties/import"
payload = { "rows": [
{
"line1": "<string>",
"postcode": "<string>",
"town": "<string>"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"created": [
{
"id": "<string>",
"line1": "<string>",
"postcode": "<string>"
}
],
"skipped": [
{
"line1": "<string>",
"postcode": "<string>",
"reason": "<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.
Body
application/json
Maximum array length:
500Show child attributes
Show child attributes