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

Responses

200

OK

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstringOptional

multiplebooleanOptional

externalIdstring · nullableOptional

displayOrderinteger · int32 · nullableOptional

optionsany · nullableOptional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

scopestring · enumOptionalPossible values:

phasestring · enumOptionalPossible values:

contextstring · enumOptionalPossible values:

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: 238

{
  "name": "text",
  "description": "text",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true,
    "capacity": {
      "min": 1,
      "max": 1
    }
  },
  "options": {
    "hintText": "text",
    "defaultValue": "None"
  },
  "group": {
    "id": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-06-12T05:13:30.861Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2026-06-12T05:13:30.861Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "revision": 1,
  "description": "text",
  "multiple": true,
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true,
    "capacity": {
      "min": 1,
      "max": 1
    }
  },
  "options": null,
  "type": "SingleLineText",
  "status": "Active",
  "group": {
    "id": "text",
    "name": "text",
    "revision": 1
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "product": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "published": "[Circular Reference]",
      "pending": "[Circular Reference]",
      "unpublished": "[Circular Reference]"
    },
    "$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",
      "audit": "[Circular Reference]",
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        "[Circular Reference]"
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    },
    "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
    }
  }
}