Queue

Update an existing queue

Updates a queue and allows replacing its icon using multipart form data.

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

Request

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

Path parameters

idstring required

The ID of the queue to update.

Request body

idstring
namestring
iconstring nullable
revisioninteger
longDescriptionstring

Gets or sets the long description associated with the queue.

shortDescriptionstring

Gets or sets the short description associated with the queue.

externalIdstring nullable

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

status'Disabled' | 'Active'
defaultboolean

Indicates whether this queue is the default queue.

internalboolean

Indicates whether this queue is internal.

isDeletedboolean

Indicates whether the queue has been marked as deleted.

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
longDescriptionstring

Gets or sets the long description associated with the queue.

shortDescriptionstring

Gets or sets the short description associated with the queue.

externalIdstring nullable

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

status'Disabled' | 'Active'
defaultboolean

Indicates whether this queue is the default queue.

internalboolean

Indicates whether this queue is internal.

isDeletedboolean

Indicates whether the queue has been marked as deleted.

Changes

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