Forms

Update an existing form

The form ID is provided in the route.

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

Request

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

Path parameters

idstring required

The ID of the form to update.

Request body

idstring
namestring
iconstring nullable
revisioninteger
descriptionstring nullable

Gets or sets the description associated with the form.

status'Unpublished' | 'Published'
externalIdstring nullable

Gets or sets the optional external identifier associated with the form.

isDeletedboolean

Indicates whether the queue has been marked as deleted.

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
descriptionstring nullable

Gets or sets the description associated with the form.

status'Unpublished' | 'Published'
externalIdstring nullable

Gets or sets the optional external identifier associated with the form.

isDeletedboolean

Indicates whether the queue has been marked as deleted.

Changes

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