Create
curl --request POST \
--url https://api.sortx.co.uk/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "<string>",
"dueOn": "<string>",
"requestId": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
subject: {kind: '<string>', id: '<string>'},
assigneeContactId: '<string>',
assigneeUserId: '<string>',
assigneeStaffId: '<string>',
teamId: '<string>',
taskTypeId: '<string>',
branchId: '<string>',
priority: '<string>',
dueOn: '<string>',
requestId: '<string>'
})
};
fetch('https://api.sortx.co.uk/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/tasks"
payload = {
"title": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "<string>",
"dueOn": "<string>",
"requestId": "<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>",
"subjectKind": "<string>",
"subjectId": "<string>",
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "urgent",
"dueOn": "<string>",
"status": "<string>",
"createdByUserId": "<string>",
"dedupeKey": "<string>",
"requestId": "<string>",
"revision": 123,
"createdAt": "<string>",
"doneAt": "<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>"
}tasks
Create
Create a task
POST
/
tasks
Create
curl --request POST \
--url https://api.sortx.co.uk/tasks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "<string>",
"dueOn": "<string>",
"requestId": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
subject: {kind: '<string>', id: '<string>'},
assigneeContactId: '<string>',
assigneeUserId: '<string>',
assigneeStaffId: '<string>',
teamId: '<string>',
taskTypeId: '<string>',
branchId: '<string>',
priority: '<string>',
dueOn: '<string>',
requestId: '<string>'
})
};
fetch('https://api.sortx.co.uk/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/tasks"
payload = {
"title": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "<string>",
"dueOn": "<string>",
"requestId": "<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>",
"subjectKind": "<string>",
"subjectId": "<string>",
"assigneeContactId": "<string>",
"assigneeUserId": "<string>",
"assigneeStaffId": "<string>",
"teamId": "<string>",
"taskTypeId": "<string>",
"branchId": "<string>",
"priority": "urgent",
"dueOn": "<string>",
"status": "<string>",
"createdByUserId": "<string>",
"dedupeKey": "<string>",
"requestId": "<string>",
"revision": 123,
"createdAt": "<string>",
"doneAt": "<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:
urgent, high, normal, low