Contents x
    Publishes an article with an id
    • 25 Nov 2023
    • 4 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Publishes an article with an id

    • Updated on 25 Nov 2023
    • 4 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Post
    /v2/Articles/{articleId}/{langCode}/publish
    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
    Publish Article Request Example

    Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.

    {
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Publishing my article with new changes."
}
    object
    user_id
    string Required

    The ID of the team account that will be marked as the contributor of this publish

    Min length1
    version_number
    integer (int32) Required

    The version number of the article to be published

    Maximum32767
    Minimum1
    publish_message
    string

    The publish message of the article

    Publish Article Request Example

    Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.

    {
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Publishing my article with new changes."
}
    object
    user_id
    string Required

    The ID of the team account that will be marked as the contributor of this publish

    Min length1
    version_number
    integer (int32) Required

    The version number of the article to be published

    Maximum32767
    Minimum1
    publish_message
    string

    The publish message of the article

    Publish Article Request Example

    Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.

    {
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Publishing my article with new changes."
}
    object
    user_id
    string Required

    The ID of the team account that will be marked as the contributor of this publish

    Min length1
    version_number
    integer (int32) Required

    The version number of the article to be published

    Maximum32767
    Minimum1
    publish_message
    string

    The publish message of the article

    Publish Article Request Example

    Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.

    {
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Publishing my article with new changes."
}
    object
    user_id
    string Required

    The ID of the team account that will be marked as the contributor of this publish

    Min length1
    version_number
    integer (int32) Required

    The version number of the article to be published

    Maximum32767
    Minimum1
    publish_message
    string

    The publish message of the article

    Responses
    200

    Success

    Publish Article Request Example

    Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.

    {
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    object (ArticleSimpleDataCustomer)
    id
    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 Deprecated

    The default language code

    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 response

    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

    ALready published Article

    This is repeated task that, this article has already published

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article has already been published.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    version_number Not Found

    version_number is missing or null, kindly verify the version number and perform the task again.

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The field VersionNumber must be between 1 and 32767.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    article_id Not Found

    Kindly verify the article_id and perform the task again.

    {
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "One or more errors occurred. (Article not found).",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    article Not Found

    Kindly verify the articleId or langCode and perform the task again.

    {
  "extension_data": null,
  "success": true,
  "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)
    id
    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 Deprecated

    The default language code

    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 response

    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