Revoke tenant portal access
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/tenants/{contactId}/portal-access/revoke \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/tenants/{contactId}/portal-access/revoke', 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/tenants/{contactId}/portal-access/revoke"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"email": "<string>",
"status": "pending",
"invitedAt": "<string>",
"acceptedAt": "<string>",
"revokedAt": "<string>",
"homes": 123,
"reportedRepairs": 123,
"inviteBlocked": "<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
Revoke tenant portal access
Close a tenant’s portal login; a new invitation reopens it
POST
/
maintenance-pro
/
tenants
/
{contactId}
/
portal-access
/
revoke
Revoke tenant portal access
curl --request POST \
--url https://api.sortx.co.uk/maintenance-pro/tenants/{contactId}/portal-access/revoke \
--header 'x-api-key: <api-key>'const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/tenants/{contactId}/portal-access/revoke', 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/tenants/{contactId}/portal-access/revoke"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"email": "<string>",
"status": "pending",
"invitedAt": "<string>",
"acceptedAt": "<string>",
"revokedAt": "<string>",
"homes": 123,
"reportedRepairs": 123,
"inviteBlocked": "<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
Response
Success
Available options:
pending, active, revoked