curl --request POST \
--url https://{host}/api/public/feedback/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"survey": "<string>",
"rating": 123,
"session_id": "<string>",
"comment": "<string>",
"externalUserId": "<string>",
"channel": "<string>",
"response_source": "external",
"message_id": "<string>"
}
'{
"success": true,
"data": {
"response_id": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Submit rating for survey
Submit a rating against a named survey
curl --request POST \
--url https://{host}/api/public/feedback/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"survey": "<string>",
"rating": 123,
"session_id": "<string>",
"comment": "<string>",
"externalUserId": "<string>",
"channel": "<string>",
"response_source": "external",
"message_id": "<string>"
}
'{
"success": true,
"data": {
"response_id": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}feedback-survey:write permission.Headers
^abl_Path Parameters
Body
The survey this rating answers, by name.
The value given, on the survey control's own scale. Validated against the resolved survey's range and rejected (422 INVALID_INPUT) when out of range — never clamped.
The conversation this rating belongs to, if the caller knows it.
Open-text comment. Optional; readable by any caller holding the read scope.
4000The caller's own identifier for the respondent. Never used for scoring.
The caller's own channel label for this response.
How the caller categorises the capture source. Stored as given so a partner can distinguish its own sub-sources. It does not change origin (resolved from the credential) or the score.
The caller's own message or turn identifier, stored for correlation.
Was this page helpful?