Skip to content

Rate one of Rosie’s answers

POST
/public/assistant/sessions/{id}/messages/{messageId}/feedback
curl --request POST \
--url https://example.com/public/assistant/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/messages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/feedback \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "helpful": true, "reason": "wrong", "comment": null }'

A thumbs up or down on an answer in this conversation. A thumbs down says why: wrong, not_answered, hard_to_follow, or other with a short description. Rating again replaces the rating.

id
required
string format: uuid
messageId
required
string format: uuid
Media typeapplication/json
object
helpful
required
boolean
reason
string | null
Allowed values: wrong not_answered hard_to_follow other
comment
string | null
>= 1 characters <= 500 characters

Rating saved

Missing, wrong or expired session token

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Rosie is not set up here

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}

Rating changed too many times

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}