Add an article
  • Updated on 21 Feb 2019
  • 1 minute to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Add an article

  • Print
  • Share
  • Dark
    Light

POST/articles

Adds an article to an existing category


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
title string Title of the article
category_id string The ID of the category where article will be created
project_version_id string The project version ID in which the article will be created
user_id string The ID of the user that will be marked as an author of this article
content string Markdown content of the article
order number The position of the article in the category tree (Default is 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"
}

Sample Response

{
    "data": {
        "id": "b14e9514-20b2-43b0-a750-4a25c75a6fea",
        "title": "My Article",
        "public_version": 0,
        "latest_version": 1,
        "hidden": false,
        "status": 0,
        "order": 6,
        "slug": "my-article"
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Data

Parameter Type Description
id string ID of the article
title string Article title
public_version number The version number that is currently published
latest_version number The latest version number of this article
hidden boolean Indicates if article is visible in on the site
status enumerated The status of the article: 0 - Draft, 1 - InReview, 2 - Public, 3 - Published, 4 - Deleted
order number The position inside the parent category
slug string The slug of the article
Was this article helpful?