---
title: "Update a guide"
method: PATCH
path: "/environments/{environmentId}/guides/{guideId}"
tags: ["environments"]
---

# Update a guide

`PATCH /environments/{environmentId}/guides/{guideId}`

Updates a guide

## Path parameters

- `environmentId` string, required — Environment ID
- `guideId` string, required — Guide ID

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Request body

- TypeEnvironmentsGuideUpdateRequest — Update a guide
  - `description` string
  - `title` string
  - `metadata` object
  - `slug` string
  - `versions` TypeEnvironmentsGuideVersionResource[]
    - `id` string, required
    - `version` integer, required
    - `content` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `blocks` object[]
  - `environmentId` string

## Response `200`

Response with status 200

- TypeEnvironmentsGuideDetailResponse
  - `data` TypeEnvironmentsGuideResource, required — A guide
    - `id` string, required — Guide ID
    - `description` string
    - `metadata` object
    - `slug` string, required
    - `title` string, required
    - `versions` TypeEnvironmentsGuideVersionResource[], required
      - `id` string, required
      - `version` integer, required
      - `content` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `blocks` object[], required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/revisions/9d3a9979cd96/schema)