Create appointment
curl --request POST \
--url https://api.sortx.co.uk/calendar/appointments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"date": "<string>",
"startMinute": 123,
"durationMinutes": 123,
"title": "<string>",
"contactId": "<string>",
"propertyId": "<string>",
"staffId": "<string>",
"location": "<string>",
"notes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
date: '<string>',
startMinute: 123,
durationMinutes: 123,
title: '<string>',
contactId: '<string>',
propertyId: '<string>',
staffId: '<string>',
location: '<string>',
notes: '<string>'
})
};
fetch('https://api.sortx.co.uk/calendar/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/calendar/appointments"
payload = {
"requestId": "<string>",
"date": "<string>",
"startMinute": 123,
"durationMinutes": 123,
"title": "<string>",
"contactId": "<string>",
"propertyId": "<string>",
"staffId": "<string>",
"location": "<string>",
"notes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"title": "<string>",
"kind": "<string>",
"subjectKind": "<string>",
"subjectId": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"location": "<string>",
"status": "<string>",
"createdByUserId": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"staffId": "<string>",
"staffUserId": "<string>",
"staffName": "<string>",
"contactId": "<string>",
"contactName": "<string>",
"notes": "<string>",
"revision": 123,
"outcome": "attended",
"outcomeNote": "<string>",
"outcomeRecordedAt": "<string>",
"feedback": {
"interest": "keen",
"themes": [
"<string>"
],
"nextAction": "send_offer",
"note": "<string>"
},
"followUpTaskId": "<string>",
"cancelReason": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": {
"kind": "user",
"userId": "<string>"
},
"followUp": {
"id": "<string>",
"title": "<string>",
"dueOn": "<string>",
"status": "<string>"
},
"history": [
{
"id": "<string>",
"revision": 123,
"action": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"previousStartsAt": "<string>",
"previousEndsAt": "<string>",
"staffId": "<string>",
"staffName": "<string>",
"previousStaffId": "<string>",
"previousStaffName": "<string>",
"status": "<string>",
"note": "<string>",
"detail": {},
"actorUserId": "<string>",
"actor": {
"kind": "user",
"userId": "<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>"
}calendar
Create appointment
Book an appointment on the agency’s wall clock with its contact, property and member of staff
POST
/
calendar
/
appointments
Create appointment
curl --request POST \
--url https://api.sortx.co.uk/calendar/appointments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"date": "<string>",
"startMinute": 123,
"durationMinutes": 123,
"title": "<string>",
"contactId": "<string>",
"propertyId": "<string>",
"staffId": "<string>",
"location": "<string>",
"notes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
date: '<string>',
startMinute: 123,
durationMinutes: 123,
title: '<string>',
contactId: '<string>',
propertyId: '<string>',
staffId: '<string>',
location: '<string>',
notes: '<string>'
})
};
fetch('https://api.sortx.co.uk/calendar/appointments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/calendar/appointments"
payload = {
"requestId": "<string>",
"date": "<string>",
"startMinute": 123,
"durationMinutes": 123,
"title": "<string>",
"contactId": "<string>",
"propertyId": "<string>",
"staffId": "<string>",
"location": "<string>",
"notes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"title": "<string>",
"kind": "<string>",
"subjectKind": "<string>",
"subjectId": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"location": "<string>",
"status": "<string>",
"createdByUserId": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"staffId": "<string>",
"staffUserId": "<string>",
"staffName": "<string>",
"contactId": "<string>",
"contactName": "<string>",
"notes": "<string>",
"revision": 123,
"outcome": "attended",
"outcomeNote": "<string>",
"outcomeRecordedAt": "<string>",
"feedback": {
"interest": "keen",
"themes": [
"<string>"
],
"nextAction": "send_offer",
"note": "<string>"
},
"followUpTaskId": "<string>",
"cancelReason": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": {
"kind": "user",
"userId": "<string>"
},
"followUp": {
"id": "<string>",
"title": "<string>",
"dueOn": "<string>",
"status": "<string>"
},
"history": [
{
"id": "<string>",
"revision": 123,
"action": "<string>",
"startsAt": "<string>",
"endsAt": "<string>",
"previousStartsAt": "<string>",
"previousEndsAt": "<string>",
"staffId": "<string>",
"staffName": "<string>",
"previousStaffId": "<string>",
"previousStaffName": "<string>",
"status": "<string>",
"note": "<string>",
"detail": {},
"actorUserId": "<string>",
"actor": {
"kind": "user",
"userId": "<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
Available options:
front-desk.viewing, front-desk.valuation, front-desk.callback, inspection, meeting, other Response
Success
Available options:
attended, no_show Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes