> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # BulkDeleteRibbons # Package: catalogV3 # Namespace: RibbonService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/bulk-delete-ribbons.md ## Permission Scopes: Ribbon write in v3 catalog: SCOPE.STORES.RIBBON_WRITE ## Introduction Deletes multiple ribbons. --- ## REST API ### Schema ``` Method: bulkDeleteRibbons Description: Deletes multiple ribbons. URL: https://www.wixapis.com/stores/v3/bulk/ribbons/delete Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ribbonIds Method parameters: param name: ribbonIds | type: array | description: IDs of ribbons to delete. | required: true Return type: BulkDeleteRibbonsResponse - name: results | type: array | description: Ribbons deleted by bulk action. - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk delete ribbons Delete 2 ribbons at once ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/bulk/ribbons/delete' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "ribbonIds": [ "b3b45015-5fc8-45c0-bf72-d1c4271e0439", "a05cae3a-d9e3-45c2-8811-01d682ed828c" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.RibbonService.bulkDeleteRibbons(ribbonIds) Description: Deletes multiple ribbons. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ribbonIds Method parameters: param name: ribbonIds | type: array | description: IDs of ribbons to delete. | required: true Return type: PROMISE - name: results | type: array | description: Ribbons deleted by bulk action. - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### bulkDeleteRibbons ```javascript import { ribbonsV3 } from '@wix/stores'; async function bulkDeleteRibbons(ribbonIds) { const response = await ribbonsV3.bulkDeleteRibbons(ribbonIds); }; ``` ### bulkDeleteRibbons (with elevated permissions) ```javascript import { ribbonsV3 } from '@wix/stores'; import { auth } from '@wix/essentials'; async function myBulkDeleteRibbonsMethod(ribbonIds) { const elevatedBulkDeleteRibbons = auth.elevate(ribbonsV3.bulkDeleteRibbons); const response = await elevatedBulkDeleteRibbons(ribbonIds); } ``` ### bulkDeleteRibbons (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { ribbonsV3 } from '@wix/stores'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { ribbonsV3 }, // Include the auth strategy and host as relevant }); async function bulkDeleteRibbons(ribbonIds) { const response = await myWixClient.ribbonsV3.bulkDeleteRibbons(ribbonIds); }; ``` ---