Checklist

Deletes all checklists matching any of the given criteria

There are three ways to delete checklists.

You can pass a list of checklist ids:

DELETE: api/checklist/delete-many { "checklistIds": [ 985, 1321 ], "templateKeys": [], "checklistStatus": "" }

You can pass a list of template keys. When doing this you must also pass the checklist status. The statuses are: ALL, INPROGRESS, COMPLETE, SCHEDULED

DELETE: api/checklist/delete-many { "checklistIds": [], "templateKeys": [ "F6395E1C-2DD5-41E5-87C1-9F9804ECA0A1", "A59BA9AE-9E81-434A-AB0B-56EE51EBD157" ], "checklistStatus": "ALL" }

You can pass just the checklist status. All checklists matching the status will be deleted. The statuses are: ALL, INPROGRESS, COMPLETE, SCHEDULED

DELETE: api/checklist/delete-many { "checklistIds": [], "templateKeys": [], "checklistStatus": "ALL" }

You can pass a combination of the above to delete checklists in different ways in one call.

DELETE: api/checklist/delete-many { "checklistIds": [ 985, 1321 ], "templateKeys": [ "F6395E1C-2DD5-41E5-87C1-9F9804ECA0A1", "A59BA9AE-9E81-434A-AB0B-56EE51EBD157" ], "checklistStatus": "COMPLETE" }

delete/api/checklist/delete-many

Request

  • Base URL: https://app.checkflow.io (the document declares no server; this is the origin it was published from)
  • URL: https://app.checkflow.io/api/checklist/delete-many
  • Auth: none declared

Headers

X-API-VERSIONstring

The requested API version

X-API-KEYunknown

API Key

Request body

checklistIdsinteger[] nullable
templateKeysstring[] nullable
checklistStatusstring nullable

Response

If the checklists were deleted successfully

Changes

No recorded changes to this operation across all 1 revision of this API.