ParameterGroup

Update an existing parameter group

The parameter group ID is provided in the route.

put/public/v1/helpdesk/parameter-groups/{id}

Request

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

Path parameters

idstring required

The ID of the parameter group to update.

Request body

idstring
namestring
iconstring nullable
revisioninteger
labelstring

The translatable label for the parameter group

descriptionstring nullable

The optional description providing additional context for the parameter group

externalIdstring nullable

The optional external identifier associated with the parameter group

isDeletedboolean

Indicates whether the parameter group has been marked as deleted

Example request

{
  "label": "Customer Information",
  "description": "Basic customer details and contact information",
  "parameters": [
    {
      "description": "Customer contact email address",
      "externalId": "EXT-PARAM-123",
      "displayOrder": 1
    }
  ]
}

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
labelstring

The translatable label for the parameter group

descriptionstring nullable

The optional description providing additional context for the parameter group

externalIdstring nullable

The optional external identifier associated with the parameter group

isDeletedboolean

Indicates whether the parameter group has been marked as deleted

Example response

{
  "label": "Customer Information",
  "description": "Basic customer details and contact information",
  "parameters": [
    {
      "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.