Update compliance settings
curl --request PUT \
--url https://api.sortx.co.uk/compliance/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"reminderLeadDays": [
123
],
"remindLandlord": true,
"remindContractor": true,
"reviewMonths": {}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
reminderLeadDays: [123],
remindLandlord: true,
remindContractor: true,
reviewMonths: {}
})
};
fetch('https://api.sortx.co.uk/compliance/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/settings"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"reminderLeadDays": [123],
"remindLandlord": True,
"remindContractor": True,
"reviewMonths": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"reminderLeadDays": [
123
],
"remindLandlord": true,
"remindContractor": true,
"reviewMonths": {},
"revision": 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>"
}compliance
Update compliance settings
Change reminder lead days and recipients and the review periods (owner or admin)
PUT
/
compliance
/
settings
Update compliance settings
curl --request PUT \
--url https://api.sortx.co.uk/compliance/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"reminderLeadDays": [
123
],
"remindLandlord": true,
"remindContractor": true,
"reviewMonths": {}
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
reminderLeadDays: [123],
remindLandlord: true,
remindContractor: true,
reviewMonths: {}
})
};
fetch('https://api.sortx.co.uk/compliance/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/settings"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"reminderLeadDays": [123],
"remindLandlord": True,
"remindContractor": True,
"reviewMonths": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"reminderLeadDays": [
123
],
"remindLandlord": true,
"remindContractor": true,
"reviewMonths": {},
"revision": 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