SmartMatchApp

Update Checklist Item

Update the description or checked state of a specific checklist item. Only the fields included in the request body will be modified.

Example Requests:

Mark an item as checked:

curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/checklists/<checklist_id>/items/<item_id>/" \
    -u <token>: \
    -X PUT \
    -d "checked=true"

Update description and uncheck:

curl "https://<your-agency>.smartmatchapp.com/api3/tasks/<task_id>/checklists/<checklist_id>/items/<item_id>/" \
    -u <token>: \
    -X PUT \
    -d "description=Review the updated proposal" \
    -d "checked=false"
Request Parameters:

description: (Optional) The new text for the checklist item.

checked: (Optional) The completion state. Accepts true or false.

Example Success Response:
HTTP 204 No Content
Base Request:

Method: PUT

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

This error occurs if checked is not true or false.
Possible errors: "invalid value"
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404 Not Found

This error occurs if the task, checklist, or item with the specified ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than PUT is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"