Skip to content

Tasks — Create, Update & Delete

Create new items, update column values, delete tasks, and add comments. Use GET /boards/{boardId} to discover column IDs and types before writing field values.

POST/api/access/tasks/boards/{boardId}/itemsBearer Token

Create Item

Create a new item in a board.

Required permission: CreateItems

Path Parameters

ParameterTypeDescription
boardIdstringTarget board ID

Query Parameters

ParameterTypeDefaultDescription
providerstringautoProvider code

Request Body

FieldTypeRequiredDescription
namestringYesItem name/title
groupIdstring?NoTarget group/section within the board
fieldsobject?NoColumn values \u2014 keys are column IDs, values are provider-specific JSON strings. Use GET /boards/{boardId} to discover column IDs and types.
{
"name": "New task from API",
"groupId": "new_group",
"fields": {
"status": "{\"label\":\"Working on it\"}",
"date4": "{\"date\":\"2026-04-15\"}"
}
}

See TaskItemResult for full response schema.

Error Responses

StatusDescription
400name is empty or missing
403Board not in token scope or create not allowed for this board
502Provider rejected the creation
PATCH/api/access/tasks/items/{itemId}Bearer Token

Update Item

Update column values on an existing item.

Required permission: UpdateItems

Path Parameters

ParameterTypeDescription
itemIdstringItem ID to update

Query Parameters

ParameterTypeDefaultDescription
providerstringautoProvider code

Request Body

FieldTypeRequiredDescription
fieldsobjectYesColumn values to update. Key = column ID, Value = provider-specific JSON string. At least one field required.
{
"fields": {
"status": "{\"label\":\"Done\"}",
"date4": "{\"date\":\"2026-04-20\"}"
}
}

Warning

rejectedFields lists any fields the provider refused to update (e.g. locked columns, invalid values). The operation can still partially succeed \u2014 check both success and rejectedFields.

See TaskItemResult for full response schema.

Error Responses

StatusDescription
400fields is empty
403ACCESS_DENIED or NO_WRITABLE_FIELDS — update blocked
404Item not found
502Provider error
DELETE/api/access/tasks/items/{itemId}Bearer Token

Delete Item

Permanently delete a task item from the provider.

Required permission: DeleteItems

Path Parameters

ParameterTypeDescription
itemIdstringItem ID to delete

Query Parameters

ParameterTypeDefaultDescription
providerstringautoProvider code

Response 200 OK

{
"provider": "MONDAY",
"success": true,
"errorCode": null,
"errorMessage": null
}

See TaskOperationResult for full response schema.

Error Responses

StatusDescription
403Delete blocked (ACCESS_DENIED)
404Item not found
502Provider error
POST/api/access/tasks/items/{itemId}/commentsBearer Token

Add Comment

Add a comment/update to a task item.

Required permission: AddComments

Path Parameters

ParameterTypeDescription
itemIdstringItem ID to comment on

Query Parameters

ParameterTypeDefaultDescription
providerstringautoProvider code

Request Body

FieldTypeRequiredDescription
bodystringYesComment text content
{
"body": "This is ready for review."
}

See TaskCommentResult for full response schema.

Error Responses

StatusDescription
400body is empty
403Comment blocked (ACCESS_DENIED)
404Item not found
502Provider error

Result Types

TaskItemResult

Returned by Create Item (201) and Update Item (200).

FieldTypeDescription
providerstring?Provider code
successboolWhether the operation succeeded
itemIdstring?Created or updated item ID
itemItem?Full item object (when returned by the provider)
errorCodestring?Error code: ACCESS_DENIED, NOT_FOUND, NO_WRITABLE_FIELDS
errorMessagestring?Human-readable error message
rejectedFieldsstring[]?Fields the provider refused to update (partial success scenarios)

TaskOperationResult

Returned by Delete Item (200).

FieldTypeDescription
providerstring?Provider code
successboolWhether the operation succeeded
errorCodestring?Error code
errorMessagestring?Human-readable error message

TaskCommentResult

Returned by Add Comment (201).

FieldTypeDescription
providerstring?Provider code
successboolWhether the operation succeeded
commentIdstring?ID of the created comment
errorCodestring?Error code
errorMessagestring?Human-readable error message

Permissions Reference

Operation Permissions

Controlled by the token's allowedTaskOperations setting.

FlagAPI StringControls
ViewBoardsview_boardsGET /boards, GET /boards/{boardId}
ViewItemsview_itemsGET /boards/{boardId}/items, GET /items/{itemId}
ViewCommentsview_commentsComments included in item responses
CreateItemscreate_itemsPOST /boards/{boardId}/items
UpdateItemsupdate_itemsPATCH /items/{itemId}
DeleteItemsdelete_itemsDELETE /items/{itemId}
AddCommentsadd_commentsPOST /items/{itemId}/comments
ManageGroupsmanage_groupsReserved for future use
ReadOnlyread_onlyComposite: view_boards + view_items + view_comments
AllallAll operations