Add landlord
curl --request POST \
--url https://api.sortx.co.uk/contacts/landlords \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"companyNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"postalAddress": {
"line1": "<string>",
"postcode": "<string>",
"line2": "<string>",
"town": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
contactFirstName: '<string>',
contactLastName: '<string>',
companyNumber: '<string>',
email: '<string>',
phone: '<string>',
postalAddress: {line1: '<string>', postcode: '<string>', line2: '<string>', town: '<string>'}
})
};
fetch('https://api.sortx.co.uk/contacts/landlords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contacts/landlords"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"companyNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"postalAddress": {
"line1": "<string>",
"postcode": "<string>",
"line2": "<string>",
"town": "<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>",
"name": "<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>"
}contacts
Add landlord
Add a landlord: a person, or a company with its contact person, with how they prefer to hear from us and where letters go
POST
/
contacts
/
landlords
Add landlord
curl --request POST \
--url https://api.sortx.co.uk/contacts/landlords \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"companyNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"postalAddress": {
"line1": "<string>",
"postcode": "<string>",
"line2": "<string>",
"town": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
companyName: '<string>',
contactFirstName: '<string>',
contactLastName: '<string>',
companyNumber: '<string>',
email: '<string>',
phone: '<string>',
postalAddress: {line1: '<string>', postcode: '<string>', line2: '<string>', town: '<string>'}
})
};
fetch('https://api.sortx.co.uk/contacts/landlords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contacts/landlords"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"companyName": "<string>",
"contactFirstName": "<string>",
"contactLastName": "<string>",
"companyNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"postalAddress": {
"line1": "<string>",
"postcode": "<string>",
"line2": "<string>",
"town": "<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>",
"name": "<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
Body
application/json