Karbon · Schema
UpdateWorkItem
The properties that can be updated on a Work Item with the PATCH method
CompanyAccountingPractice ManagementWorkflowsCollaborationProfessional ServicesSoftware-as-a-Service
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-update-work-item-schema.json",
"title": "UpdateWorkItem",
"description": "The properties that can be updated on a Work Item with the PATCH method",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/karbonhq-work-items-api-openapi.yml#/components/schemas/UpdateWorkItem",
"type": "object",
"anyOf": [
{
"properties": {
"Title": {
"type": "string",
"maxLength": 200,
"description": "The title of the Work Item. Must be non-empty and no longer than 200 characters when included."
}
}
},
{
"properties": {
"Description": {
"type": "string",
"description": "A free form text field to add more information about the Work Item"
}
}
},
{
"properties": {
"StartDate": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date"
}
],
"description": "The start date of the Work Item as an ISO 8601 date or date-time. Must be non-null when included."
}
}
},
{
"properties": {
"DueDate": {
"oneOf": [
{
"type": [
"string",
"null"
],
"format": "date-time"
},
{
"type": [
"string",
"null"
],
"format": "date"
}
],
"description": "The due date of the Work Item as an ISO 8601 date or date-time. Pass `null` to clear the existing due date."
}
}
},
{
"properties": {
"DeadlineDate": {
"oneOf": [
{
"type": [
"string",
"null"
],
"format": "date-time"
},
{
"type": [
"string",
"null"
],
"format": "date"
}
],
"description": "The deadline of the workitem as ISO8601 formated datestamp or timestamp"
}
}
},
{
"properties": {
"AssigneeEmailAddress": {
"type": "string",
"format": "email",
"description": "The email address of the Karbon user the Work Item should be assigned to. Validated against existing users; unknown values return a `400`."
}
}
},
{
"properties": {
"WorkType": {
"type": "string",
"description": "The work type label, validated against work types configured on the account. Unknown values return a `400`."
}
}
},
{
"properties": {
"UserRoleAssignments": {
"type": "array",
"description": "The full set of user role assignments for the Work Item. Replaces the existing assignments. Reassigning a role also moves any time estimates on that role to the new user.",
"items": {
"type": "object",
"required": [
"RoleKey",
"UserProfileKey"
],
"properties": {
"RoleKey": {
"type": "string",
"description": "A Karbon-generated value used to identify the role of the user"
},
"UserProfileKey": {
"type": "string",
"description": "A Karbon-generated value used to identify the user"
}
}
}
}
}
}
]
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/karbonhq-update-work-item"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.