Create Product Parameter

Create a product parameter.

post

Path parameters

productIdstringRequired

Body

application/jsontext/jsonapplication/*+json

scopestring · enum · min: 1RequiredPossible values:

phasestring · enum · min: 1RequiredPossible values:

contextstring · enum | nullableOptionalPossible values:

namestring · min: 1Required

descriptionstring · min: 1Required

externalIdstring | nullableOptional

displayOrderinteger · int32Required

typestring · enum · min: 1RequiredPossible values:

optionsone ofOptional

or

or

or

or

or

or

or

or

objectOptional

or

or

or

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/catalog/products/{productId}/parameters HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "name": "text",
  "description": "text",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "type": "SingleLineText",
  "options": {
    "hintText": "text",
    "defaultValue": "None"
  },
  "group": {
    "id": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-05-17T09:11:32.397Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-05-17T09:11:32.397Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$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"
    },
    "icon": "text",
    "status": "text"
  },
  "options": null,
  "type": "SingleLineText",
  "status": "text"
}