Checklists

Create a checklist item

Adds a new item to a checklist. When checklist_id is supplied, the item is added to that checklist. When it's omitted, the item is added to the franchise-wide "Shared Checklist" (created on first use).

Required permission: assigned_event_write (when the authenticated user is assigned to the target checklist's event) or unassigned_event_write (otherwise). Staff users without admin role need the per-checklist allow_staff_edit flag instead; customers need allow_customer_edit. Items on user-checklists (personal task lists) can only be created by their owner.

post/api/v1/checklist_items

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/checklist_items
  • Auth: none declared. Required headers: Api-Key

Headers

Api-Keystring required

Your Integration Key

Request body

titlestring required

Item title

notesstring

Free-form notes

due_onstring

Due date (YYYY-MM-DD)

checklist_idinteger

Optional ID of the checklist to add the item to. Omit to use the franchise-wide Shared Checklist.

checkedboolean

Whether the new item should start in the checked state

user_idsinteger[]

Staff member IDs to assign to this item

Response

checklist item created

Changes

No recorded changes to this operation across all 2 revisions of this API.