Deskhero Developer Hub
Back to deskhero.com
Knowledge bases

Rate

Records a thumbs up or thumbs down on an article, rate must be UP or DOWN and the calling User needs group access to the article. A User's vote is remembered for 12 hours: repeating the same value inside that window changes nothing, while switching moves the count from one side to the other instead of adding a second vote.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/knowledge_bases/rate/{id}
Authorisation
Minimum role: USER

Request arguments

Name Type Source
idInt32
inputDTO_knowledge_base_rate_inputBody
Request body example

Response

Status
200 (OK)
Type
DTO_acknowledgement
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_knowledge_base_rate_input
NameTypeReadOnlyDescription
rateENUM knowledge_base_rateRate
DTO_acknowledgement
NameTypeReadOnlyDescription
messageStringMessage
ENUM knowledge_base_rate
ValueNameDescription
0UNKNOWNUNKNOWN
1NOT_SETNOT SET
2UPUP
3DOWNDOWN

Generated Aug 4, 2026 18:37