> 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 # UpdateLabel # Package: items # Namespace: RestaurantsMenusItemLabels # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-labels/update-label.md ## Permission Scopes: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES ## Introduction > **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new). Updates an item Label. Each time an item label is updated, its revision increments by 1. The existing revision must be included when updating the item labels. This ensures you're working with the latest item labels information, and it prevents unintended overwrites. --- ## REST API ### Schema ``` Method: updateLabel Description: > **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new). Updates an item Label. Each time an item label is updated, its revision increments by 1. The existing revision must be included when updating the item labels. This ensures you're working with the latest item labels information, and it prevents unintended overwrites. URL: https://www.wixapis.com/restaurants/menus/v1/labels/{label.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: label, label.id, label.revision Method parameters: param name: label | type: Label | required: true - name: id | type: string | description: Item label GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. | required: true - name: name | type: string | description: Item label name. - name: icon | type: Image | description: Item label icon. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: UpdateLabelResponse - name: label | type: Label | description: Updated item label. - name: id | type: string | description: Item label GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. - name: createdDate | type: string | description: Date and time the item label was created. - name: updatedDate | type: string | description: Date and time the item label was updated. - name: name | type: string | description: Item label name. - name: icon | type: Image | description: Item label icon. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). ``` ### Examples ### Update a label ```curl curl -X PATCH "https://www.wixapis.com/restaurants/item-labels/v1/labels/72ff374d-578a-41f4-8747-168dc7cc9984" \ -H 'Authorization: ' \ --data-binary '{ "label": { "id": "72ff374d-578a-41f4-8747-168dc7cc9984", "name": "Vegan", "icon": { "id": "ec845c_7ad0026abeb3490d9fcd524a438f5218.svg", "url": "https://static.wixstatic.com/shapes/ec845c_7ad0026abeb3490d9fcd524a438f5218.svg", "height": 24, "width": 24 }, "revision": "1" }, "mask": { "paths": [ "name" ] } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.items.RestaurantsMenusItemLabels.updateLabel(_id, label) Description: > **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new). Updates an item Label. Each time an item label is updated, its revision increments by 1. The existing revision must be included when updating the item labels. This ensures you're working with the latest item labels information, and it prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: label, _id, label.revision Method parameters: param name: _id | type: string | description: Item label GUID. | required: true param name: label | type: UpdateLabel | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. | required: true - name: name | type: string | description: Item label name. - name: icon | type: string | description: Item label icon. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: PROMISE