Update Product Parameter

Update a product parameter definition.

put

Path parameters

productIdstringRequired

idstringRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstringOptional

externalIdstring | nullableOptional

displayOrderinteger · int32Optional

optionsone ofOptional

or

or

or

or

or

or

or

or

objectOptional

or

or

or

groupall ofOptional

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/public/v1/catalog/products/{productId}/parameters/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/catalog/products/{productId}/parameters/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "name": "text",
  "description": "text",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "Required": true,
    "Hidden": true,
    "ReadOnly": true
  },
  "options": {
    "hintText": "text",
    "defaultValue": "text"
  },
  "group": {
    "id": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-12-14T02:54:41.020Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-14T02:54:41.020Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "group": {
    "id": "text",
    "name": "text"
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "options": null,
  "type": "SingleLineText",
  "status": "text"
}