Create epc planner link
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/epc-planner/links \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"landlordContactId": "<string>",
"expectedGeneration": 123,
"expiresInDays": 123,
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
landlordContactId: '<string>',
expectedGeneration: 123,
expiresInDays: 123,
note: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/epc-planner/links', 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/epc-planner/links"
payload = {
"requestId": "<string>",
"landlordContactId": "<string>",
"expectedGeneration": 123,
"expiresInDays": 123,
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"landlordContactId": "<string>",
"landlordName": "<string>",
"generation": 123,
"state": "live",
"url": "<string>",
"path": "<string>",
"note": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"revokedAt": "<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>"
}maintenance-pro
Create epc planner link
Make a read-only EPC planner link for one landlord’s properties (replaces their previous link)
POST
/
maintenance-pro
/
epc-planner
/
links
Create epc planner link
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/epc-planner/links \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"landlordContactId": "<string>",
"expectedGeneration": 123,
"expiresInDays": 123,
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
landlordContactId: '<string>',
expectedGeneration: 123,
expiresInDays: 123,
note: '<string>'
})
};
fetch('https://api.sortx.co.uk/maintenance-pro/epc-planner/links', 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/epc-planner/links"
payload = {
"requestId": "<string>",
"landlordContactId": "<string>",
"expectedGeneration": 123,
"expiresInDays": 123,
"note": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"landlordContactId": "<string>",
"landlordName": "<string>",
"generation": 123,
"state": "live",
"url": "<string>",
"path": "<string>",
"note": "<string>",
"expiresAt": "<string>",
"createdAt": "<string>",
"revokedAt": "<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
Response
Success
Available options:
live, expired, revoked