Update Item

put

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstringOptional

externalIdsall ofOptional

groupall ofOptional

unitall ofOptional

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

put

HTTPcURLJavaScriptPython

PUT /public/v1/catalog/items/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "name": "text",
  "description": "text",
  "externalIds": {
    "vendor": "text",
    "operations": "text"
  },
  "group": {
    "id": "text"
  },
  "unit": {
    "id": "text"
  },
  "parameters": [
    {
      "id": "text",
      "value": null
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-21T13:33:02.788Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-21T13:33:02.788Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "pending": {
      "at": "2025-06-21T13:33:02.788Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "published": {
      "at": "2025-06-21T13:33:02.788Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "unpublished": {
      "at": "2025-06-21T13:33:02.788Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "externalIds": {
    "vendor": "text",
    "operations": "text"
  },
  "group": {
    "id": "text",
    "name": "text"
  },
  "unit": {
    "id": "text",
    "description": "text",
    "name": "text"
  },
  "terms": {
    "period": "1m",
    "commitment": "1m"
  },
  "quantityNotApplicable": true,
  "status": "text",
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "parameters": [
    {
      "id": "text",
      "externalId": "text",
      "type": "text",
      "name": "text",
      "value": null,
      "displayValue": "text"
    }
  ]
}