---
title: "Update paths"
method: PATCH
path: "/v2/paths/"
tags: ["Paths"]
---

# Update paths

`PATCH /v2/paths/`

## Request

- Base URL: `https://api.skilljar.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.skilljar.com/v2/paths/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/paths/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update paths in bulk. A row that fails is reported per item (207); the rest are still updated.

**Required OAuth scope:** `paths:write`

## Request body

- PathUpdateRequestEnvelope: JSON:API envelope for PATCH /v2/paths/.
  - `data` PathUpdateData[], required: Paths to update.
    - `type` 'paths', required: Must be "paths".
    - `id` string, required: Obfuscated path id.
    - `attributes` PathWriteAttributes, required: Writable attributes for POST and PATCH /v2/paths/; omitted fields keep their default or stay unchanged.
      - `title` string: Path title.
      - `short_description` string: Short description shown on path tiles.
      - `long_description_html` string: Long description as HTML.
      - `header_html` string: HTML shown at the top of the path page.
      - `course_name_singular` string: Replaces 'Course' on the tile.
      - `course_name_plural` string: Label that replaces 'Courses'.
      - `promo_image` union: HTTPS URL of the promo image, fetched after the response. Write-only. Empty string clears it.
        - string
        - ''

## Response `200`

OK

- BatchResultEnvelopePathResource
  - `data` union[], required: Per-item results in request order.
    - union
      - BatchSucceededItemPathResource
        - `status` 'succeeded'
        - `id` string, nullable: Resource ID of the created or updated resource.
        - `result` PathResource, required: JSON:API resource object for a path.
          - `type` string: Always "paths".
          - `id` string, required: Opaque path ID. Use in URL paths.
          - `attributes` PathAttributes, required: Attributes of a path resource object.
            - `external_id` string, required: Stable UUID5 for cross-system correlation.
            - `title` string, required: Path title.
            - `short_description` string, required: Short description shown on path tiles.
            - `long_description_html` string, required: Long description as HTML content.
            - `header_html` string, required: HTML shown at the top of the path page in the catalog.
            - `course_name_singular` string, required: Label that replaces 'Course' on the catalog tile.
            - `course_name_plural` string, required: Label that replaces 'Courses' on the catalog tile.
            - `promo_image_url` string, required: Promo image URL, or "" if no image is set.
            - `path_item_count` integer, required: Number of items in the path.
            - `created_at` string, date-time, required: Creation timestamp.
            - `modified_at` string, date-time, required: Latest update to the path or any of its items.
          - `links` object, nullable: Self link.
      - BatchFailedItem: Wrapper for a failed item in a 207 batch response.
        - `status` 'failed'
        - `id` string, nullable: Echoed resource ID if the input identified a row.
        - `error` BatchItemError, required: Per-item error inside a 207 batch response. Aligned with JSON:API ``ErrorObject`` field naming (``code`` rather than ``reason``) so consumers can reuse error-handling logic across document-level errors (``ErrorObject`` in ``ErrorEnvelope``) and per-item errors (here). Differences from ``ErrorObject``: ``status``/``title`` are omitted because they're redundant for the 207-batch context (HTTP status is on the envelope, and the title is derivable from ``code``).
          - `code` 'duplicate_email' | 'duplicate_in_batch' | 'duplicate_name' | 'validation_error' | 'not_found' | 'internal_error' | 'not_in_domain' | 'already_enrolled' | 'already_published' | 'already_in_path', required: Machine-readable error code.
          - `source` object, nullable: Pointer to the offending input slot, e.g. {"pointer": "/data/0/attributes/email"}.
          - `detail` string, nullable: Human-readable explanation of the error.
  - `summary` BatchSummary, required: Aggregate counts for a 207 batch response. Invariant: ``succeeded + failed == total``. Enforced by ``@model_validator``.
    - `total` integer, required: Total number of items submitted.
    - `succeeded` integer, required: Number of items that succeeded.
    - `failed` integer, required: Number of items that failed.

## Other responses

- `207`: Multi-Status
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `406`: Not Acceptable: Accept rules out application/vnd.api+json.
- `413`: Payload Too Large: the request body exceeds the maximum allowed size.
- `415`: Unsupported Media Type: Content-Type must be application/json or application/vnd.api+json.
- `422`: Unprocessable Entity

## Changes

- **2026-10-21** `16a566965a72`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/skilljar/apis/skilljar-api-v2/changes/v2/paths/patch.md)

---

[API](https://skmtc.dev/skilljar/apis/skilljar-api-v2.md) - [All operations](https://skmtc.dev/skilljar/apis/skilljar-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/skilljar/apis/skilljar-api-v2/revisions/fbda30ce1742?raw)