Chat

Update an existing Chat

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

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

Request

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

Path parameters

idstring required

The ID of the Chat to update.

Request body

idstring
namestring
iconstring nullable
revisioninteger
descriptionstring nullable

Gets or sets the description associated with the chat.

type'Direct' | 'Group' | 'Channel' | 'Case'

Example request

{
  "attachments": [
    {
      "file": {
        "filename": "report.pdf",
        "size": 102400,
        "contentType": "application/pdf"
      }
    }
  ]
}

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
descriptionstring nullable

Gets or sets the description associated with the chat.

type'Direct' | 'Group' | 'Channel' | 'Case'

Example response

{
  "attachments": [
    {
      "file": {
        "filename": "report.pdf",
        "size": 102400,
        "contentType": "application/pdf"
      }
    }
  ]
}

Changes

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