Updates an article with the ID

26 Sep 2023
11 Minutes to read
Contributors

Print
Share
Dark
Light

Updates an article with the ID

Updated on 26 Sep 2023
11 Minutes to read
Contributors

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Put

/v2/Articles/{articleId}/{langCode}

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters

articleId

stringRequired

The ID of the article

langCode

stringRequired

Language code of the article

Default"en"

Body parameters

Update article wth article Id for default language

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "0",
  "source": "uat"
}

Update article wth article Id for article in the state of need translation

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "1",
  "source": "uat"
}

Update article wth article Id with translation you had made

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "2",
  "source": "uat"
}

object

title

string

The title of the article

content

string

The content of the article, for any Editor type, use this property.

html_content

string Deprecated

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

category_id

string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden

boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number

integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option

string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source

string

Free text used for future reference

Update article wth article Id for default language

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "0",
  "source": "uat"
}

Update article wth article Id for article in the state of need translation

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "1",
  "source": "uat"
}

Update article wth article Id with translation you had made

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "2",
  "source": "uat"
}

object

title

string

The title of the article

content

string

The content of the article, for any Editor type, use this property.

html_content

string Deprecated

category_id

string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden

boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number

integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option

string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source

string

Free text used for future reference

Update article wth article Id for default language

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "0",
  "source": "uat"
}

Update article wth article Id for article in the state of need translation

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "1",
  "source": "uat"
}

Update article wth article Id with translation you had made

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "2",
  "source": "uat"
}

object

title

string

The title of the article

content

string

The content of the article, for any Editor type, use this property.

html_content

string Deprecated

category_id

string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden

boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number

integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option

string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source

string

Free text used for future reference

Update article wth article Id for default language

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "0",
  "source": "uat"
}

Update article wth article Id for article in the state of need translation

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "1",
  "source": "uat"
}

Update article wth article Id with translation you had made

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, and source.

{
  "title": "updated article title",
  "content": "Hi this is an API article Sample. This is updated.",
  "html_content": "Hi this is an API article Sample. This is updated.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": true,
  "version_number": 1,
  "translation_option": "2",
  "source": "uat"
}

object

title

string

The title of the article

content

string

The content of the article, for any Editor type, use this property.

html_content

string Deprecated

category_id

string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden

boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number

integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option

string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source

string

Free text used for future reference

Responses

200

Success

Article Created Successfully

The article has been created under the following category. you can use the article Id to view the article in the portal.

{
  "data": {
    "id": "a1096061-e842-41fd-9085-494095e401b9",
    "title": "Knowledge bases are much easier to design and edit",
    "content": "Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.",
    "html_content": null,
    "category_id": "de104b39-db97-4509-8d4c-deeac74d448b",
    "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
    "version_number": 1,
    "public_version": 1,
    "latest_version": 2,
    "enable_rtl": false,
    "hidden": false,
    "status": 2,
    "order": 0,
    "created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "authors": [
      {
        "id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
        "customer_id": "d9d0ff1a-99d5-46cc-af47-6ed7833e8aac",
        "status": 0,
        "first_name": "peter",
        "last_name": "jone",
        "user_description": null,
        "fresh_chat_restore_id": null,
        "last_login_date": null,
        "signup_date": null,
        "unique_user_name": "peter-jone",
        "is_user_existin_current_project": false,
        "scheme_name": null,
        "initial_tour_shown": false,
        "authentication_id": null,
        "email_id": "peterjone@mail.com",
        "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
        "profile_logo_cdn_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E",
        "is_enterprise_user": false
      }
    ],
    "created_at": "2023-09-26T06:34:59.4012654Z",
    "modified_at": "2023-09-26T06:34:59.4012661Z",
    "slug": "Knowledge-bases-are-much-easier-to-design-and edit",
    "is_fall_back_content": false,
    "description": null,
    "article_index": null,
    "category_type": 0,
    "content_type": null,
    "is_shared_article": false
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object (ArticleSimpleDataCustomer)

string

The ID of the article

title

string

The article title

public_version

integer (int32)

The article version number(revision) that is currently published

latest_version

integer (int32)

The latest version number of this article

language_code

string

Language code of the article

hidden

boolean

Indicates if the article is visible on the site

status

integer (int32)

The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

Valid values[0,1,2,3,4,5]

order

integer (int32)

The position of the article inside the parent category

slug

string

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string

Stack trace for error response message

description

string

Description for error cause

error_code

string

Error code for Api resonse

custom_data

object

warnings

Array of object (BaseWarning)

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

400

Bad Request

Article Not Found

Kindly verify the article Id and Langauage code, and peroform the task again.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article not found",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

data

object (ArticleSimpleDataCustomer)

string

The ID of the article

title

string

The article title

public_version

integer (int32)

The article version number(revision) that is currently published

latest_version

integer (int32)

The latest version number of this article

language_code

string

Language code of the article

hidden

boolean

Indicates if the article is visible on the site

status

integer (int32)

The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

Valid values[0,1,2,3,4,5]

order

integer (int32)

The position of the article inside the parent category

slug

string

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string

Stack trace for error response message

description

string

Description for error cause

error_code

string

Error code for Api resonse

custom_data

object

warnings

Array of object (BaseWarning)

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

Was this article helpful?

What's Next

Deletes an article version