Update itemCategories

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Update the properties of an item category object for Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

PATCH businesscentralPrefix/companies({id})/itemCategories({id})
PATCH businesscentralPrefix/companies({id})/items(id)/itemCategory({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the itemCategories, the itemCategories will not be updated.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Response

If successful, this method returns a 200 OK response code and an updated itemCategories object in the response body.

Example

Request

Here is an example of the request.

PATCH https://{businesscentralPrefix}/api/v2.0/companies({id})/itemCategories({id})
Content-type: application/json

{
  "displayName": "Office Chair - swivel"
}

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

{
    "id": "dd1a6a90-44e3-ea11-bb43-000d3a2feca1",
    "code": "CHAIR",
    "displayName": "Office Chair - swivel",
    "lastModifiedDateTime": "2020-08-21T00:24:31.777Z"
}

See also

Tips for working with the APIs
itemcategory
Get itemcategory
Delete itemcategory
Create itemcategory