SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Add a task type. A workspace can have up to 100 (409 type_limit); 409 type_exists and prefix_taken when the name or number prefix is in use. Needs a key or connection of a member who may set up Tasks

POSThttps://app.softsolz.uk/api/v1/services/tasks/types

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Body Params

namestringrequired

Type name, up to 80 characters.

descriptionstring | null

Short description.

colourstring

Colour shown on cards.

iconstring

Icon shown on cards.

number_prefixstring | null

Letters put before task numbers of this type, for example HK.

default_category_idinteger | null

Category given by default.

default_prioritystring | null

Priority given by default.

default_submission_modestring | null

How work is handed in.

checklistarray of objects

Checklist items new tasks of this type start with.

task_fieldsarray | null

Extra fields on tasks of this type. Null uses the category or workspace fields.

assignment_fieldsarray | null

Extra fields on work of this type.

status_statesarray | null

Statuses for work of this type. Null uses the category or workspace set.

assignment_defaultsobject

How work of this type is given out by default.

sort_orderinteger

Position in lists.

is_activeboolean

Whether new tasks can use this type.

form_idinteger | null

A published form filled in on the work.

form_rulesobject

What happens when the form fails a check.

requires_signatureboolean

The form needs a signature.

is_restrictedboolean

Only the people involved and the named viewers see tasks of this type.

viewer_user_idsarray of integers

Members who may see restricted tasks of this type.

Response

Response Body

idintegerTask type id.
namestringType name, up to 80 characters.
descriptionstring | nullShort description.
colourstringColour shown on cards.
iconstringIcon shown on cards.
number_prefixstring | nullLetters put before task numbers of this type, for example HK.
default_category_idinteger | nullCategory given by default.
default_prioritystring | nullPriority given by default.
default_submission_modestring | nullHow work is handed in.
checklistarray of objectsChecklist items new tasks of this type start with.
task_fieldsarray | nullExtra fields on tasks of this type. Null uses the category or workspace fields.
assignment_fieldsarray | nullExtra fields on work of this type.
status_statesarray | nullStatuses for work of this type. Null uses the category or workspace set.
assignment_defaultsobjectHow work of this type is given out by default.
sort_orderintegerPosition in lists.
is_activebooleanWhether new tasks can use this type.
form_idinteger | nullA published form filled in on the work.
form_rulesobjectWhat happens when the form fails a check.
requires_signaturebooleanThe form needs a signature.
is_restrictedbooleanOnly the people involved and the named viewers see tasks of this type.
viewer_user_idsarray of integersMembers who may see restricted tasks of this type.
is_deletedbooleanTrue once the type was removed.
task_countintegerTasks that use this type.
updated_atstringWhen the type last changed.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/tasks/types \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Inspection",
"colour": "amber",
"number_prefix": "INS"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
"data": {
"id": 4,
"name": "Inspection",
"description": "your-description",
"colour": "blue",
"icon": "ListChecks",
"number_prefix": "HK",
"default_category_id": 1,
"default_priority": "low",
"default_submission_mode": "your-default-submission-mode",
"checklist": [
{}
],
"task_fields": [
{}
],
"assignment_fields": [
{}
],
"status_states": [
{}
],
"assignment_defaults": {
"mode": "independent",
"requires_acceptance": true,
"strategy": "all"
},
"sort_order": 1,
"is_active": true,
"form_id": 1,
"form_rules": {},
"requires_signature": true,
"is_restricted": true,
"viewer_user_ids": [
1
],
"is_deleted": true,
"task_count": 1,
"updated_at": "2026-01-01T09:00:00.000Z"
}
}