Answer

Create a new answer from a published form

CreateAnswer Creates a new answer within the specified chat by initializing parameters from a published form template. All form parameters are created with null values and constraints copied from their definitions. The form must have Published status; otherwise, a 400 error is returned. Available for authenticated chat participants.

post/public/v1/helpdesk/chats/{chatId}/answers

Request

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

Path parameters

chatIdstring required

The unique identifier of the chat

Request body

idstring
namestring
iconstring nullable
revisioninteger
status'Draft' | 'Submitted' | 'Querying' | 'Accepted'

Defines the lifecycle status of an answer in the helpdesk system

isDeletedboolean

Indicates whether the answer has been soft-deleted

Example request

{
  "chat": {
    "attachments": [
      {
        "file": {
          "filename": "report.pdf",
          "size": 102400,
          "contentType": "application/pdf"
        }
      }
    ]
  },
  "parameters": [
    {
      "id": "PDE-1234-5678-9012",
      "externalId": "customer-name",
      "error": {
        "id": "E000001",
        "message": "Required field is empty"
      },
      "groups": [
        {
          "displayOrder": 1
        }
      ]
    }
  ]
}

Response

Created

idstring
namestring
iconstring nullable
revisioninteger
status'Draft' | 'Submitted' | 'Querying' | 'Accepted'

Defines the lifecycle status of an answer in the helpdesk system

isDeletedboolean

Indicates whether the answer has been soft-deleted

Example response

{
  "chat": {
    "attachments": [
      {
        "file": {
          "filename": "report.pdf",
          "size": 102400,
          "contentType": "application/pdf"
        }
      }
    ]
  },
  "parameters": [
    {
      "id": "PDE-1234-5678-9012",
      "externalId": "customer-name",
      "error": {
        "id": "E000001",
        "message": "Required field is empty"
      },
      "groups": [
        {
          "displayOrder": 1
        }
      ]
    }
  ]
}

Changes

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