Update agency compliance
curl --request PUT \
--url https://api.sortx.co.uk/compliance/agency \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"redressScheme": "<string>",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>"
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
redressScheme: '<string>',
redressMembershipNumber: '<string>',
redressRenewalOn: '<string>'
})
};
fetch('https://api.sortx.co.uk/compliance/agency', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/agency"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"redressScheme": "<string>",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"redressScheme": "unknown",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>",
"revision": 0,
"policyVersion": "<string>",
"updatedAt": "<string>",
"updatedByUserId": "<string>",
"history": [
{
"id": "<string>",
"kind": "<string>",
"detail": "<string>",
"actorUserId": "<string>",
"policyVersion": "<string>",
"createdAt": "<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>"
}compliance
Update agency compliance
Record the agency’s redress scheme membership (owner or admin)
PUT
/
compliance
/
agency
Update agency compliance
curl --request PUT \
--url https://api.sortx.co.uk/compliance/agency \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"expectedRevision": 123,
"redressScheme": "<string>",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>"
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
expectedRevision: 123,
redressScheme: '<string>',
redressMembershipNumber: '<string>',
redressRenewalOn: '<string>'
})
};
fetch('https://api.sortx.co.uk/compliance/agency', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/agency"
payload = {
"requestId": "<string>",
"expectedRevision": 123,
"redressScheme": "<string>",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"redressScheme": "unknown",
"redressMembershipNumber": "<string>",
"redressRenewalOn": "<string>",
"revision": 0,
"policyVersion": "<string>",
"updatedAt": "<string>",
"updatedByUserId": "<string>",
"history": [
{
"id": "<string>",
"kind": "<string>",
"detail": "<string>",
"actorUserId": "<string>",
"policyVersion": "<string>",
"createdAt": "<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:
unknown, property_ombudsman, property_redress_scheme, not_required Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes