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

Bulk add articles

  • Dark
    Light

POST /articles/bulkcreate 

Creates multiple articles


Header

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


Body Parameters (Array[])

ParameterRequiredTypeDescription
titleYesstringTitle of the article
category_idYes
stringThe ID of the category where the article will be created
project_version_idYes
stringThe project version ID in which the article will be created
user_idYes
stringThe ID of the user that will be marked as an author of this article
contentNostringMarkdown content of the article
orderNonumberThe position of the article in the category tree (Default is the end of the category)


Sample Request

[
    {
      "title":"My Article",
      "project_version_id":"7ba483c0-0929-4bb6-aa43-04a2f4bb8453",
      "user_id":"5ae331f74e60146b233512x2",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My Header"
    },
    {
      "title":"My Article 2",
      "project_version_id":"7ba483c0-0929-4bb6-aa43-04a2f4bb8453",
      "user_id":"5ae331f74e60146b233512x2",
      "category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
      "content" : "## My Header 2"
    }
]


Sample Response

The response will show if all articles have been created 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 create article Final\r\nError: System.Exception: The creating user with id 5ae331f74e633558c6, does not exist in your project"
      },
      {
         "success":true,
         "details":"Successfully created article Final"
      }
   ],
   "extension_data":null,
   "context":null,
   "success":true,
   "errors":[ ],
   "warnings":[ ],
   "information":[ ]
}


Response Data (Array[])

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

Was this article helpful?