> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetokb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update article

> This API allows to update an existing article.

<Warning>
  **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
  the [v2 equivalent](/api-reference) for improved REST compliance (correct HTTP status codes,
  consistent response envelopes, and hyphenated URLs).
</Warning>

<Info>Replace `{your-subdomain}` with your workspace's subdomain. <br /> Learn how to find your subdomain in [Workspace subdomain](/getting-started/workspace-subdomain).</Info>


## OpenAPI

````yaml bundled-v1/articles.yaml PATCH /articles/{permalink_id}
openapi: 3.0.3
info:
  title: NeetoKB Articles API
  version: 1.0.0
servers:
  - description: NeetoKB API
    url: https://{your-subdomain}.neetokb.com/api/external/v1
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/getting-started/workspace-subdomain).
security: []
paths:
  /articles/{permalink_id}:
    patch:
      summary: Update article
      description: This API allows to update an existing article.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/permalink_id_param'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_article_request'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/getting-started/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    permalink_id_param:
      in: path
      name: permalink_id
      description: >-
        Unique identifier of the article. Refer to the [NeetoKB help
        article](https://help.neetokb.com/articles/permalinks) for detailed
        instructions.
      required: true
      schema:
        type: string
        example: a-84af178b
  schemas:
    update_article_request:
      type: object
      properties:
        title:
          type: string
          description: Title of the article.
          example: Getting Started
        state:
          type: string
          enum:
            - draft
            - published
          description: Status of the article.
          example: draft
        html_content:
          type: string
          description: Content of the article in HTML format.
          example: <h1>Welcome</h1><p>Example content</p>
        slug:
          type: string
          description: >-
            URL-friendly version of the article's title. Can only be modified if
            the article's state is `published`.
          example: getting-started
        page_title:
          type: string
          description: >-
            Title of the page (used for
            [SEO](https://searchengineland.com/guide/what-is-seo)). Can only be
            modified if the article's state is `published`.
          example: Getting Started
        meta_description:
          type: string
          description: >-
            Description of the article's content (used for
            [SEO](https://searchengineland.com/guide/what-is-seo)). Can only be
            modified if the article's state is `published`.
          example: A comprehensive guide to help you get started with our platform

````