@salesforce/b2c-tooling-sdk / operations/sites / removeCartridge

Function: removeCartridge()

removeCartridge(instance, siteId, cartridgeName, updateOptions?): Promise<CartridgePathResult>

Defined in: packages/b2c-tooling-sdk/src/operations/sites/cartridges.ts:180

Removes a cartridge from a site's cartridge path.

For regular sites, tries OCAPI DELETE /sites/{site_id}/cartridges/{cartridge_name} first, falling back to site archive import if OCAPI permissions are unavailable. For Business Manager (Sites-Site), always uses site archive import.

Parameters

instance

B2CInstance

B2C instance

siteId

string

Site ID

cartridgeName

string

Name of the cartridge to remove

updateOptions?

CartridgeUpdateOptions

Returns

Promise<CartridgePathResult>

Updated cartridge path

Example

await removeCartridge(instance, 'RefArch', 'old_cartridge');