ROroma
Lists

Delete a list into the trash

Delete a list by id. Deleting the list also deletes EVERY item on it. SOFT delete: the list and its items are recoverable for ~30 days via restore_deleted (type "list"), which brings the items deleted with it back too. When the list still holds items the call refuses unless confirmDeleteItems is true, so the blast radius is always named before it happens. The hub's own Tasks list and Life Admin cannot be deleted.

delete/api/v1/lists/{id}

Request

  • Base URL
    https://api.roma.app
  • URL
    https://api.roma.app/api/v1/lists/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The list's id (from list_lists).

Request body

confirmDeleteItemsboolean nullable

Required (true) when the list holds items: confirms deleting the list AND every item on it. Confirm with the user first.

Response

The tool's result.

deletedboolean required
idstring required
namestring required
itemsDeletednumber required

Changes

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