Sirportly

Toggle Menu

Toggle Item Status

This method allows you to check/uncheck items within a ticket's currently assigned checklist.

URL

/api/v2/checklists/update_item

Access

This method can be accessed by all account tokens and by user tokens where the user has access to the ticket.

Supported Parameters

  • ticket - the ticket reference you wish to work with (required)
  • item - the ID of the checklist item you wish to update (required)
  • checked - whether or not the item should be checked or unchecked (1 or 0)
  • notes - any notes you wish to store with the item (optional)

###Returned Data

If the update is successful you will receive a 200 OK status along with the current status of the item (see below). If an error occurs, you'll receive a 409 Conflict with an explanation.

Example JSON

{
    "checked": true
}
{
    "checked": false
}
{
    "error": "NotPermitted",
    "message": "You cannot uncomplete this item as a future item is not complete"
}
{
    "error": "NotPermitted",
    "message": "You cannot mark this item as completed as a previous item is not complete"
}