Inbox routing
curl --request POST \
--url https://api.sortx.co.uk/front-desk/inbox-routing \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messageText": "<string>",
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>"
}
],
"channel": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messageText: '<string>',
teams: [{id: '<string>', name: '<string>', purpose: '<string>'}],
channel: '<string>'
})
};
fetch('https://api.sortx.co.uk/front-desk/inbox-routing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/front-desk/inbox-routing"
payload = {
"messageText": "<string>",
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>"
}
],
"channel": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "suggested",
"category": "repair_report",
"categoryConfidence": 123,
"overlaps": [
"<string>"
],
"teamId": "<string>",
"teamName": "<string>",
"teamConfidence": 123,
"reasons": [
"<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>"
}front-desk
Inbox routing
Suggest what an inbound message is, what else it carries and which team should take it
POST
/
front-desk
/
inbox-routing
Inbox routing
curl --request POST \
--url https://api.sortx.co.uk/front-desk/inbox-routing \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messageText": "<string>",
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>"
}
],
"channel": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messageText: '<string>',
teams: [{id: '<string>', name: '<string>', purpose: '<string>'}],
channel: '<string>'
})
};
fetch('https://api.sortx.co.uk/front-desk/inbox-routing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/front-desk/inbox-routing"
payload = {
"messageText": "<string>",
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>"
}
],
"channel": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "suggested",
"category": "repair_report",
"categoryConfidence": 123,
"overlaps": [
"<string>"
],
"teamId": "<string>",
"teamName": "<string>",
"teamConfidence": 123,
"reasons": [
"<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:
suggested, uncertain, unavailable Available options:
repair_report, payment_query, complaint, other