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

# Update Blog Post

> Update fields and/or flip `status` to 'published'. brand/target are immutable.
Re-publishing an already-published post is a no-op success (no duplicate rebuild
dispatch). Cross-scope id → 404. Requires `blog:write`.



## OpenAPI

````yaml /openapi.json patch /v1/blog-posts/{post_id}
openapi: 3.1.0
info:
  title: ClassQuill Public API
  description: >-
    REST API for ClassQuill tutoring organisations. Pipe your sessions,
    invoices, payments, tutor earnings, students, and more into your own tools.
    Most endpoints are reads; a focused set of writes (each gated by a *:write
    scope) create or update data, including creating student/tutor/parent
    accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=cq_live_...

    Mint keys in the ClassQuill app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/blog-posts/{post_id}:
    patch:
      tags:
        - Blog
      summary: Update Blog Post
      description: >-
        Update fields and/or flip `status` to 'published'. brand/target are
        immutable.

        Re-publishing an already-published post is a no-op success (no duplicate
        rebuild

        dispatch). Cross-scope id → 404. Requires `blog:write`.
      operationId: update_blog_post_v1_blog_posts__post_id__patch
      parameters:
        - name: post_id
          in: path
          required: true
          schema:
            type: string
            title: Post Id
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlogPostUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlogPost'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            Not found — the record doesn't exist or belongs to another
            organisation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation error — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limit exceeded — honour Retry-After and the RateLimit-*
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    BlogPostUpdate:
      properties:
        title:
          anyOf:
            - type: string
              maxLength: 300
              minLength: 1
            - type: 'null'
          title: Title
        slug:
          anyOf:
            - type: string
              maxLength: 200
              pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            - type: 'null'
          title: Slug
        excerpt:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Excerpt
        content:
          anyOf:
            - type: string
              maxLength: 200000
            - type: 'null'
          title: Content
        tags:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 50
            - type: 'null'
          title: Tags
        featured_image:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Featured Image
        author:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Author
        category:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Category
        date:
          anyOf:
            - type: string
            - type: 'null'
          title: Date
        status:
          anyOf:
            - type: string
              enum:
                - draft
                - published
            - type: 'null'
          title: Status
        publish_to_website:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Publish To Website
        publish_to_portal:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Publish To Portal
        scheduled_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled At
          description: >-
            ISO 8601 datetime. Set to schedule deferred publishing; set to null
            to cancel a scheduled publish.
      additionalProperties: false
      type: object
      title: BlogPostUpdate
      description: >-
        PATCH /v1/blog-posts/{id} → blog_posts. Partial update; only these
        fields are

        writable. Flip `status` to 'published' to publish (idempotent —
        re-publishing is a

        no-op). brand/target/organization_id are immutable after creation (not
        accepted);

        updated_at is trigger-maintained.
    BlogPost:
      properties:
        id:
          type: string
          title: Id
        target:
          anyOf:
            - type: string
            - type: 'null'
          title: Target
        brand:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand
        organization_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Organization Id
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Excerpt
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
        author:
          anyOf:
            - type: string
            - type: 'null'
          title: Author
        tags:
          items:
            type: string
          type: array
          title: Tags
          default: []
        featured_image:
          anyOf:
            - type: string
            - type: 'null'
          title: Featured Image
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        date:
          anyOf:
            - type: string
            - type: 'null'
          title: Date
        publish_to_website:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Publish To Website
        publish_to_portal:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Publish To Portal
        is_pinned:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Pinned
        published_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Published At
        scheduled_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled At
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
      title: BlogPost
      description: |-
        A blog post row returned by /v1/blog-posts. `target` is derived from
        organization_id (NULL → 'platform', else 'org').
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: >-
            Stable machine-readable error code: bad_request, unauthorized,
            forbidden, not_found, conflict, validation_error, rate_limited, or
            internal_error.
          examples:
            - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
            - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
            - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: >-
            Error-specific context. 422 carries the field errors under `errors`;
            429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
        - code
        - message
        - status
      title: ApiErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=cq_live_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.