Suggest relevant articles for ticket

GET {{baseUrl}}/api/v1/tickets/:ticket_id/articleSuggestion

This API suggests help articles that could be relevant to resolving a ticket.

OAuth Scope

  • Desk.articles.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the articles must be fetched
limitstringNumber of articles to list
departmentIdstringID of the department to which the help article belongs. If you want to include help articles from all departments, pass 0 as the value of this key

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"modifiedTime":"2020-06-24T11:46:43.000Z","creatorId":"4000000000059","dislikeCount":"0","modifierId":"4000000000059","likeCount":"0","locale":"en","ownerId":"4000000000059","title":"Answering your first ticket.","isTrashed":false,"createdTime":"2020-06-24T11:46:43.000Z","modifiedBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"id":"4000000019059","viewCount":"0","owner":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"summary":"Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save ...","latestVersionStatus":"Published","author":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"permission":"AGENTS","authorId":"4000000000059","usageCount":"0","commentCount":"0","rootCategoryId":"4000000017276","translationId":"4000000017294","createdBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"latestVersion":"1.0","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en","feedbackCount":"0","portalUrl":"https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket","attachmentCount":"0","latestPublishedVersion":"1.0","category":{"name":"General","id":"4000000017287","locale":"en"},"permalink":"answering-your-first-ticket","categoryId":"4000000017287","status":"Published"}]}