Update product

Update some properties of a product.

put

Path parameters

idstringRequired

Body

multipart/form-dataapplication/json

iconstring · binaryOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

shortDescriptionstring · nullableOptional

longDescriptionstring · nullableOptional

websitestringOptional

statusstringOptional

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

put/public/v1/catalog/products/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/catalog/products/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 373

{
  "product": {
    "Product.Node.Name": "text",
    "Product.Node.Children": [
      {
        "name": "text"
      }
    ],
    "Product.Path": "text",
    "Product.Data.Name": "text",
    "Product.Data.ShortDescription": "text",
    "Product.Data.LongDescription": "text",
    "Product.Data.ExternalIds.Operations": "text",
    "Product.Data.ExternalIds.DefaultErpItem": "text",
    "Product.Data.Website": "text",
    "Product.IsDefined": true
  },
  "icon": "binary"
}

multipart/form-dataapplication/json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-08-07T19:03:25.001Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-08-07T19:03:25.001Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-08-07T19:03:25.001Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "pending": {
      "at": "2026-08-07T19:03:25.001Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-08-07T19:03:25.001Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text",
    "defaultErpItem": "text"
  },
  "website": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "settings": {
    "productOrdering": true,
    "productRequests": {
      "enabled": true,
      "name": "text",
      "label": "text"
    },
    "itemSelection": true,
    "orderQueueChanges": true,
    "preValidation": {
      "purchaseOrderDraft": true,
      "purchaseOrderQuerying": true,
      "changeOrderDraft": true,
      "configurationOrderDraft": true,
      "terminationOrder": true
    },
    "splitBilling": {
      "enabled": true,
      "type": "text"
    },
    "sendCostToErp": true,
    "subscriptionCessation": {
      "enabled": true,
      "mode": "Termination"
    }
  },
  "statistics": {
    "itemCount": 1,
    "ordersPlacedCount": 1,
    "agreementCount": 1,
    "subscriptionCount": 1
  }
}