Create Parameter Definition

Create a new parameter definition.

post

Creates a new parameter definition from the request payload.

Body

application/jsontext/jsonapplication/*+json

Parameter definition in the helpdesk system

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

scopestring · enumOptional

Defines the scope that determines where a parameter is applicable in the helpdesk system.

Possible values:

phasestring · enumOptional

Defines the phase that determines when a parameter is used in the helpdesk workflow.

Possible values:

descriptionstringOptional

The description of the parameter

Example: Customer contact email address

multiplebooleanOptional

Indicates whether the parameter can accept multiple values

Example: false

externalIdstring · nullableOptional

The optional external identifier of the parameter for integration purposes

Example: EXT-PARAM-123

displayOrderinteger · int32 · nullableOptional

The display order of the parameter where a lower value indicates higher priority in the display sequence

Example: 1

optionsany · nullableOptional

The type-specific options for the parameter which vary based on the parameter type

typestring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the parameter definition has been marked as deleted.

Responses

201

Created

application/json

403

Forbidden

application/json

500

Internal Server Error

post

/public/v1/helpdesk/parameters

HTTPcURLJavaScriptPython

POST /public/v1/helpdesk/parameters HTTP/1.1
Host: api.s1.show
Content-Type: application/json
Accept: */*
Content-Length: 1577

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "scope": "Form",
  "phase": "Request",
  "description": "Customer contact email address",
  "multiple": false,
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true,
    "capacity": {
      "min": 1,
      "max": 1
    },
    "visibility": "All"
  },
  "options": null,
  "type": "String",
  "statistics": {
    "cases": 1,
    "groups": 1,
    "forms": 1
  },
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:44:44.395Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:44:44.395Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$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": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "isDeleted": true
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-03-30T20:44:44.395Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "scope": "Form",
  "phase": "Request",
  "description": "Customer contact email address",
  "multiple": false,
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true,
    "capacity": {
      "min": 1,
      "max": 1
    },
    "visibility": "All"
  },
  "options": null,
  "type": "String",
  "statistics": {
    "cases": 1,
    "groups": 1,
    "forms": 1
  },
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-03-30T20:44:44.395Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-03-30T20:44:44.395Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$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": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "isDeleted": true
}