Skip to content
Optiwork API Docs

Update a checklist item

PATCH
/boards/{board}/cards/{card}/checklists/{checklist}/items/{checklistItem}
curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/cards/1/checklists/1/items/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_completed": true }'

Updates the item’s title, completion state, due date and/or assignees.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

card
required
integer

Card id (must belong to the board).

checklist
required
integer

Checklist id (must belong to the card).

checklistItem
required
integer

Checklist item id (must belong to the checklist).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
title
string
<= 255 characters
is_completed
boolean
due_date
string | null format: date-time
assignees
object | null
Example
{
  "is_completed": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated item.

Media typeapplication/json
object
id
integer
checklist_id
integer
title
string
<= 255 characters
is_completed
boolean
completed_at
string | null format: date-time
due_date
string | null format: date-time
due_date_status
string | null
Allowed values: OVERDUE NEAR FAR
human_due_date
string | null
short_locale_date
string | null
assignees
Array<object>
object
id
integer
uuid
string format: uuid
name
string
avatar_url
string | null format: uri
created_at
string format: date-time
Example
{
  "due_date_status": "OVERDUE"
}

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
message

First validation error message.

string
errors

Map of field name → list of error messages.

object
key
additional properties
Array<string>
Example
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}