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

Bulk publish articles

  • Print
  • Share
  • Dark
    Light

POST/articles/bulkpublish

Publishes list of articles


Header

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

Body Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
article_id string ID of the article
version_number number The version number to be published. Minimum Value 1
user_id string The id of the user that will be marked as an author of this publish

Sample Request

[
    {
        "article_id" : "123aec55-c0a7-42bf-862c-1eea02b96trt"
        "version_number": 1,
        "user_id": "5ae331f74e60146b233558c6"
    },
    {
        "article_id" : "98ehds55-c0a7-42bf-862c-1eea02b96trt"
        "version_number": 1,
        "user_id": "5ae331f74e60146b233558c6"
    }
]

Sample Response

The response will show if all articles have been published 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 publish article with an id 123aec55-c0a7-42bf-862c-1eea02b96trt"
      },
      {
         "success":true,
         "details":"Successfully published 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?