Bulk update articles
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Bulk update articles

  • Dark
    Light

PUT /articles/bulkupdate 

Updates list of articles in a given language


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.


Body Parameters (Array[])

ParameterRequiredTypeDescription
article_idYesstringThe ID of the article
lang_codeYesstringLanguage code for multilingual
titleNostringNew article title
contentNo
stringNew article markdown content
category_idNo
stringMove article to another category
hiddenNo
booleanHide / Show article
version_numberNo
numberArticle version to update (Default is latest)
translation_optionNo
stringIndicates the translation status of the article. 0 - Not applicable, 1 - Need translation, 2 - translated
sourceNo
stringFree text used for future reference


Sample Request

[
    {
      "article_id": "123aec55-c0a7-42bf-862c-1eea02b96trt",
      "lang_code": "string",
      "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,
      "translation_option": "string",
    "source": "string"
    }
]


Sample Response

The response will show if all articles have been updated successfully. The details property will include any errors and article title. After issues have been 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[])

ParameterTypeDescription
successbooleanIndicates if article creation was successful
detailsstringAdditional information about article creation status

Was this article helpful?