Update settings
curl --request PUT \
--url https://api.sortx.co.uk/front-desk/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": [
"<string>"
],
"missedCallSmsEnabled": true,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"repairStatusAutoReply": true
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assistantId: '<string>',
greetingName: '<string>',
escalationMobile: '<string>',
transferNumber: '<string>',
serviceNotes: '<string>',
openingHours: {
mon: [{from: '<string>', to: '<string>'}],
tue: [{from: '<string>', to: '<string>'}],
wed: [{from: '<string>', to: '<string>'}],
thu: [{from: '<string>', to: '<string>'}],
fri: [{from: '<string>', to: '<string>'}],
sat: [{from: '<string>', to: '<string>'}],
sun: [{from: '<string>', to: '<string>'}]
},
timezone: '<string>',
bookableKinds: ['<string>'],
missedCallSmsEnabled: true,
missedCallSmsTemplate: '<string>',
outOfHoursMessage: '<string>',
repairStatusAutoReply: true
})
};
fetch('https://api.sortx.co.uk/front-desk/settings', 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/settings"
payload = {
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": ["<string>"],
"missedCallSmsEnabled": True,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"repairStatusAutoReply": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": [
"<string>"
],
"missedCallSmsEnabled": true,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"assistantSource": "workspace",
"repairStatusAutoReply": true
}{
"_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
Update settings
Update the tenant’s receptionist settings
PUT
/
front-desk
/
settings
Update settings
curl --request PUT \
--url https://api.sortx.co.uk/front-desk/settings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": [
"<string>"
],
"missedCallSmsEnabled": true,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"repairStatusAutoReply": true
}
'const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assistantId: '<string>',
greetingName: '<string>',
escalationMobile: '<string>',
transferNumber: '<string>',
serviceNotes: '<string>',
openingHours: {
mon: [{from: '<string>', to: '<string>'}],
tue: [{from: '<string>', to: '<string>'}],
wed: [{from: '<string>', to: '<string>'}],
thu: [{from: '<string>', to: '<string>'}],
fri: [{from: '<string>', to: '<string>'}],
sat: [{from: '<string>', to: '<string>'}],
sun: [{from: '<string>', to: '<string>'}]
},
timezone: '<string>',
bookableKinds: ['<string>'],
missedCallSmsEnabled: true,
missedCallSmsTemplate: '<string>',
outOfHoursMessage: '<string>',
repairStatusAutoReply: true
})
};
fetch('https://api.sortx.co.uk/front-desk/settings', 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/settings"
payload = {
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": ["<string>"],
"missedCallSmsEnabled": True,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"repairStatusAutoReply": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"assistantId": "<string>",
"greetingName": "<string>",
"escalationMobile": "<string>",
"transferNumber": "<string>",
"serviceNotes": "<string>",
"openingHours": {
"mon": [
{
"from": "<string>",
"to": "<string>"
}
],
"tue": [
{
"from": "<string>",
"to": "<string>"
}
],
"wed": [
{
"from": "<string>",
"to": "<string>"
}
],
"thu": [
{
"from": "<string>",
"to": "<string>"
}
],
"fri": [
{
"from": "<string>",
"to": "<string>"
}
],
"sat": [
{
"from": "<string>",
"to": "<string>"
}
],
"sun": [
{
"from": "<string>",
"to": "<string>"
}
]
},
"timezone": "<string>",
"bookableKinds": [
"<string>"
],
"missedCallSmsEnabled": true,
"missedCallSmsTemplate": "<string>",
"outOfHoursMessage": "<string>",
"assistantSource": "workspace",
"repairStatusAutoReply": true
}{
"_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
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
Available options:
workspace, shared, unconfigured