PATCH

Update Ribbon

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a ribbon.

Each time the ribbon is updated, revision increments by 1. The current revision must be passed when updating the ribbon. This ensures you're working with the latest ribbon and prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Ribbon write in v3 catalog
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/stores/v3/ribbons/{ribbon.id}
Path Params
ribbon.idstringRequired

Ribbon ID.

Body Params
ribbonRibbonRequired

Ribbon to update.

fieldsArray <string>maxItems 100

Fields to include in the response.

Supported values: ASSIGNED_PRODUCTS_COUNT

Response Object
ribbonRibbon

Updated Ribbon.

Update a ribbon
Request
cURL
curl -X PATCH \
 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "ribbon": {
     "name": "New!",
     "revision": "1"
   }
 }'
Response
JSON
{
  "ribbon": {
    "id": "2254c3b3-6bbd-457d-b868-9122657c5d1c",
    "revision": "2",
    "createdDate": "2024-06-26T08:34:04.787Z",
    "updatedDate": "2024-06-26T08:39:24.371Z",
    "name": "New!"
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?