Delete Collection

Delete a collection by its readable ID.

Args: readable_id: The readable ID of the collection to delete delete_data: Whether to delete the data in destinations db: The database session current_user: The current user

Returns: The deleted collection

Path parameters

readable_idstringRequired

Query parameters

delete_databooleanOptionalDefaults to false

Response

Successful Response

namestring>=4 characters<=64 characters

Display name for the collection

readable_idstring

idstringformat: "uuid"

created_atdatetime

modified_atdatetime

organization_idstringformat: "uuid"

created_by_emailstringformat: "email"

modified_by_emailstringformat: "email"

statusenumOptional

Collection status enum.

Allowed values:

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.collections.delete_collection(
7	readable_id="readable_id",
8	)

1	{
2	"name": "Finance Data",
3	"readable_id": "finance-data",
4	"id": "550e8400-e29b-41d4-a716-446655440000",
5	"created_at": "2024-01-15T09:30:00Z",
6	"modified_at": "2024-01-15T14:22:15Z",
7	"organization_id": "org12345-6789-abcd-ef01-234567890abc",
8	"created_by_email": "admin@company.com",
9	"modified_by_email": "finance@company.com",
10	"status": "ACTIVE"
11	}

Delete Collection

Path parameters

Headers

Query parameters

Response

Errors