Skip to content
Scenario Docs
Get started
API Reference
Collections

Delete

client.collections.delete(stringcollectionID, CollectionDeleteParams { projectId } params?, RequestOptionsoptions?): CollectionDeleteResponse
DELETE/collections/{collectionId}

Delete a collection

ParametersExpand Collapse
collectionID: string
params: CollectionDeleteParams { projectId }
projectId?: string

The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

ReturnsExpand Collapse
CollectionDeleteResponse = unknown

Delete

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const collection = await client.collections.delete('collectionId');

console.log(collection);
{}
Returns Examples
{}