Skip to content
Download OpenAPI description
Languages
Servers

https://developers.taskbase.com/

Operations
Operations

Creates or updates an end-user feedback rating.

Request

There can be only one rating per interaction, therefore this operation does an update when called more than once with the same data. The api user acts on behalf of the end-user who is supposed to be the creator of the interaction.

Security
bearerAuth
Path
interactionIdstringrequired

The interaction identifier

Bodyapplication/jsonrequired
typestring
Enum"GOOD""BAD"
Example: "GOOD"
subtypestring
Enum"UNCLEAR_EXPLANATION""UNHELPFUL""TOO_STRICT""INCORRECT_FEEDBACK""TOO_GENERIC""NOT_RELEVANT""CLEAR_EXPLANATION""HELPFUL_HINT""MOTIVATION_BOOST""CORRECT_ANSWER"
Example: "HELPFUL_HINT"
messagestring
Example: "This feedback was very helpful!"
curl -i -X PUT \
  'https://developers.taskbase.com/interactions/{interactionId}/end-user-rating' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GOOD",
    "subtype": "HELPFUL_HINT",
    "message": "This feedback was very helpful!"
  }'

Responses

Successful operation

Bodyapplication/json
typestring
Enum"GOOD""BAD"
Example: "GOOD"
subtypestring
Enum"UNCLEAR_EXPLANATION""UNHELPFUL""TOO_STRICT""INCORRECT_FEEDBACK""TOO_GENERIC""NOT_RELEVANT""CLEAR_EXPLANATION""HELPFUL_HINT""MOTIVATION_BOOST""CORRECT_ANSWER"
Example: "HELPFUL_HINT"
messagestring
Example: "This feedback was very helpful!"
Response
application/json
{ "type": "GOOD", "subtype": "HELPFUL_HINT", "message": "This feedback was very helpful!" }
Operations
Operations