Bulk update articles
  • Updated on 07 Aug 2019
  • 1 minute to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Bulk update articles

  • Print
  • Share
  • Dark
    Light

PUT/articles/bulkupdate

Updates list of articles


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Body Parameters Array[]

Parameters highlighted in bold are mandatory

Parameter Type Description
article_id string ID of the article
title string New article title
content string New article markdown content
category_id string Move article to another category
hidden boolean Hide / Show article
version_number number Article version to update ( Default is latest )

Sample Request

[
    {
      "article_id": "123aec55-c0a7-42bf-862c-1eea02b96trt",
      "title":"My New Title",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My new content",
      "hidden" : false
    },
    {
      "article_id": "98ehds55-c0a7-42bf-862c-1eea02b96trt",
      "title":"My New Title 2",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My new content 2",
      "hidden" : false
    }
]

Sample Response

The response will show if all articles have been updated succesfully. The details property will include any errors and article title, after issues have been be fixed, articles can be resubmitted for further processing.

{
   "data":[
      {
         "success":false,
         "details":"Failed to update article with an id 123aec55-c0a7-42bf-862c-1eea02b96trt"
      },
      {
         "success":true,
         "details":"Successfully updated article with an id 98ehds55-c0a7-42bf-862c-1eea02b96trt"
      }
   ],
   "extension_data":null,
   "context":null,
   "success":true,
   "errors":[ ],
   "warnings":[ ],
   "information":[ ]
}

Response Data Array[]

Parameter Type Description
success boolean Indicates if article creation was successful
details string Additional information about article creation status
Was this article helpful?