Create Parameter

post

Path parameters

programIdstringRequired

Body

application/jsontext/jsonapplication/*+json

scopestring · enum · min: 1RequiredPossible values:

phasestring · enum · min: 1RequiredPossible 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

/public/v1/program/programs/{programId}/parameters

HTTPcURLJavaScriptPython

POST /public/v1/program/programs/{programId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 270

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

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-12-17T08:42:01.760Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-17T08:42:01.760Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "group": {
    "id": "text",
    "name": "text"
  },
  "scope": "Enrollment",
  "phase": "Order",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "program": {
    "id": "text",
    "name": "text",
    "status": "text",
    "applicableTo": "text",
    "products": [
      {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "shortDescription": "text",
        "longDescription": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "website": "text",
        "icon": "text",
        "status": "text",
        "vendor": {
          "id": "text",
          "icon": "text",
          "type": "text",
          "status": "text",
          "name": "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,
            "productRequest": true
          },
          "splitBilling": {
            "enabled": true,
            "type": "text"
          },
          "subscriptionCessation": {
            "enabled": true,
            "mode": "Termination"
          }
        },
        "statistics": {
          "itemCount": 1,
          "ordersPlacedCount": 1,
          "agreementCount": 1,
          "subscriptionCount": 1,
          "requestCount": 1
        }
      }
    ]
  },
  "options": null,
  "type": "SingleLineText",
  "status": "text"
}