Delete a collection
delete_collectionDelete a collection and all contained face, selfie, and photo records; default soft delete allows restore within 7 days, while immediate or compliance erasure is irreversible.
Instructions
Delete a collection and every face, selfie and photo record in it. By default this is a SOFT delete: the collection is hidden at once and purged after a 7-day grace period, and restore_collection undoes it until then. immediate=true starts the purge now and cannot be undone. compliance=true records an audited erasure (GDPR/BIPA) and cannot be restored. An immediate or compliance erase of a collection that still holds faces or selfies is refused with confirmation_required until confirm_erase=true. Confirm with the user before calling this. Free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| immediate | No | Purge now instead of after the grace period. Irreversible. | |
| compliance | No | Audited legal erasure. Irreversible and never restorable. | |
| collection_id | Yes | Collection id, e.g. an event or album id. Any text except '/', '\', '.' and '..'. | |
| confirm_erase | No | Set true once the user has confirmed they want to erase a collection that still holds faces. When the answer is confirmation_required, tell the user what will be erased, ask, and retry with this. |