Wipe Collection Documents

DELETE

https://api.runcaptain.com/v2/collections/:collection_name/documents

Remove all documents from a collection while keeping the collection structure.

collection_namestringRequired

Name of the collection to wipe

Documents Wiped

successboolean or null

messagestring or null

documents_deletedinteger or null

1	import requests
2
3	url = "https://api.runcaptain.com/v2/collections/collection_name/documents"
4
5	headers = {
6	"Authorization": "Bearer YOUR_API_KEY",
7	"X-Organization-ID": "YOUR_ORG_UUID"
8	}
9
10	response = requests.delete(url, headers=headers)
11
12	print(response.json())

1	{
2	"success": true,
3	"message": "All documents have been successfully removed from the collection 'customer_profiles'.",
4	"documents_deleted": 1250
5	}