Delete a list (privileged)

Removes a list from the system.

When you delete a list, the list's definition and any import or purge jobs that are associated with the list are removed.

IMPORTANT: Deleting a list does not remove the list's contents. If required, you should remove the list's contents before you delete the list. To clear the list's contents, you must create a purge job. See the /lists/{listId}/purgeJobs endpoint for details. This two-step process for clearing and deleting a list is due to the non-deterministic time it could take to clear the contents of a list.

There is an exception to the two-step process for clearing and deleting a list. When you delete an immutable list ('isImmutable' is set to 'true'), the contents and list are removed in a single synchronous call. This is due to the restriction that you cannot create a purge job for an immutable list. It is recommended that very large lists are not immutable.

You only can delete a list when its 'state' property is set to 'developing' and the list is not part of a relationship that is registered in the Catalog service.

A list's deletion fails if the list has any associated import or purge jobs that are running. If you believe that an import or purge job is incorrectly marked as running, you can force a list to delete. Doing so does not stop import or purge jobs that are running. You cannot force a list to delete when the 'state' property is set to 'deployed' or the list is involved in a relationship.