Parameter

Updates existing parameter definition.

Updates existing parameter definition.

put/public/v1/helpdesk/parameters/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/parameters/{id}
  • Auth: none declared

Path parameters

idstring required

Identifier of the parameter definition to be updated.

Request body

idstring
namestring
iconstring nullable
revisioninteger
scope'Case' | 'Form'

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

phase'Request' | 'Response'

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

descriptionstring

The description of the parameter

multipleboolean

Indicates whether the parameter can accept multiple values

externalIdstring nullable

The optional external identifier of the parameter for integration purposes

displayOrderinteger nullable

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

optionsunknown
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'
isDeletedboolean

Indicates whether the parameter definition has been marked as deleted.

Example request

{
  "description": "Customer contact email address",
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1
}

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
scope'Case' | 'Form'

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

phase'Request' | 'Response'

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

descriptionstring

The description of the parameter

multipleboolean

Indicates whether the parameter can accept multiple values

externalIdstring nullable

The optional external identifier of the parameter for integration purposes

displayOrderinteger nullable

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

optionsunknown
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'
isDeletedboolean

Indicates whether the parameter definition has been marked as deleted.

Example response

{
  "description": "Customer contact email address",
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.