PUT /task-type/
Update Task Type
PUT
/task-type/{type_key}
Replace an existing task type document.
Performs a full replacement of the TaskType document identified by
type_key. Only fields present in the request body are written
(exclude_unset=True), so omitted optional fields retain their current
database values.
Emits: (direct transaction — no event class)
Required scope: collaboration:task-type:write
Authorizations
OAuth2PasswordBearer
password Flow
Token URL
"/api/auth"Scopes:
"admin"User can access and edit users and system settings"library"User can access and edit products"production"User can access and edit production plans"operator"User can access the operator panel and make production declarations
Parameters
Path Parameters
type_key*
Type
Requiredstring
Request Body
application/json
JSON "_id": "string", "_key": "string", "_rev": "string", "name": "Quality Inspection", "description": "Covers all quality checks mandated by the production process.", "active": true, "icon": "check_circle", "created": "2026-05-01T08:00:00Z", "form_fields": [ { "_key": "ffd-001", "custom_field_key": "cf-001", "multiple": false, "label": "Colour Code", "hint": "Verify against approved colour chart", "default": "pass", "mandatory": false, "hidden": false } ], "link_settings": [ { "type": "issue", "enabled": true, "allow_multiple": false, "required": false } ], "require_time_entry": false
{
}
Responses
Successful Response
application/json
JSON "status": 200, "message": "string", "detail": "string"
{
}