Submit custom chat surveys

Overview

Use this API to submit custom survey forms shown at the end of chat session by providing conversation ID.

SecurityoAuthAnonymousCustomer
Request
path Parameters
id
required
string <= 255 characters

id of object

Example: 1001
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema:

SurveyForm schema

Array of objects (question) >= 0 items
Responses
202

Success

400

Bad Request

406

Not Acceptable

500

Internal server error

post/conversation/{id}/survey
Request samples
{
  • "question": [
    ]
}
Response samples
application/json
{
  • "code": "400-152",
  • "developerMessage": "Invalid value is provided in the request body for the following attribute:'<attribute_name>'."
}