USusepylon
articles

Create an article

Changed on

Creates a new article within a knowledge base.

Rate limit: 30 requests per minute

post/knowledge-bases/{id}/articles

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/knowledge-bases/{id}/articles
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the knowledge base the article is being added to.

Request body

author_user_idstring required

The ID of the user attributed as the author of the article.

body_htmlstring

The HTML body of the article. Required unless body_markdown is set.

body_markdownstring

The body of the article in markdown, instead of body_html.

collection_idstring

The ID of the collection containing the article.

is_publishedboolean

Whether the article should be published. Defaults to false.

is_unlistedboolean

Whether the article is accessible only via a direct link. Defaults to false.

positioninteger

The zero-based position among the parent's articles and subcollections. Defaults to the end. Positions beyond the end append the article.

slugstring

The slug of the article. Defaults to a slug based on the title.

titlestring required

The title of the article.

Example request

{
  "visibility_config": {
    "customer_visibility_condition": {
      "subfilters": [
        {
          "field": "state",
          "operator": "equals",
          "value": "new"
        }
      ]
    }
  }
}

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "tags": [
      {
        "object_type": "issue"
      }
    ],
    "visibility_config": {
      "customer_visibility_condition": {
        "subfilters": [
          {
            "field": "state",
            "operator": "equals",
            "value": "new"
          }
        ]
      }
    }
  }
}

Changes

  • 8522e66913b4Revision changes
    • warning

      added the new not enum value to the /// response property for the response status

    • warning

      added the new time_is_in_last enum value to the /// response property for the response status

    • warning

      added the new time_is_in_next enum value to the /// response property for the response status

    • warning

      added the new time_is_not_in_last enum value to the /// response property for the response status

    • warning

      added the new time_is_not_in_next enum value to the /// response property for the response status

    • info

      added the new not enum value to the request property //

    • info

      added the new time_is_in_last enum value to the request property //

    • info

      added the new time_is_in_next enum value to the request property //

    • info

      added the new time_is_not_in_last enum value to the request property //

    • info

      added the new time_is_not_in_next enum value to the request property //

  • 94eafdd80c67Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status