Update an article

PATCH {{baseUrl}}/api/v1/articles/:article_id

This API updates an existing article.

OAuth Scope

  • Desk.articles.UPDATE

Request Params

KeyDatatypeRequiredDescription
categoryIdstringThe Category
titlestringThe title of Solution
answerstringThe answer part of Solution
permalinkstringThe permalink of Solution
authorIdstringThe owner of the solution
statusstringStatus of the Solution
permissionstringPermission of the Solution
tagsstringTags associated with the Solution
seoTitlestringSEO Title of Solution
seoKeywordsstringSEO Key of Solution
seoDescriptionstringSEO Description of Solution
isSEOEnabledstringSEO enabled status of an article
expiryDatestringSchedule expiry date

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"modifiedTime":"2020-06-24T11:46:43.000Z","reviewedTime":"2020-06-24T11:46:43.000Z","creatorId":"4000000000059","dislikeCount":"0","modifierId":"4000000000059","likeCount":"0","locale":"en","ownerId":"4000000000059","title":"Answering your first ticket.","expiryDate":null,"isTrashed":false,"createdTime":"2020-06-24T11:46:43.000Z","modifiedBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"id":"4000000019059","viewCount":"0","seo":{"keywords":"helpcenter, knowledge base","isEnabled":true,"description":"Knowledge base","title":"Helpcenter and knowledge base"},"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","myVote":null,"author":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"permission":"AGENTS","authorId":"4000000000059","reviewedBy":{"photoURL":null,"name":"Hill","id":"4000000000059","status":"ACTIVE","zuid":"234543"},"currentVersion":"1.0","usageCount":"0","commentCount":"0","rootCategoryId":"4000000017276","tags":["first ticket"],"answer":"\u003cp\u003eZoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly.\u003cbr\u003e\u003cbr\u003eThe 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 time on frequently asked questions.\u003cbr\u003e\u003cbr\u003eEvery action that you can perform with respect to a ticket has a corresponding keyboard shortcut. With these, you can optimize the time you spend on each ticket. (And the shortcut to access these shortcuts is Shift + ? ).When you need to quickly consult a colleague, you can tag them in a ticket comment without having to leave this screen. That's like a quick chat, without even leaving your place, and with the full context of the ticket.\u003cbr\u003e\u003cbr\u003eWith these, you're good to go.\u003cbr\u003e\u003cbr\u003eGo on, save the world from bad customer service!\u003c/p\u003e","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"}