---
title: "Update a guidance"
method: PATCH
path: "/spaces/{spaceId}/guidance/{guidanceId}"
tags: ["spaces"]
---

# Update a guidance

`PATCH /spaces/{spaceId}/guidance/{guidanceId}`

Updates a guidance with the given id

## Path parameters

- `spaceId` string, required — Space ID
- `guidanceId` string, required — Guidance ID

## Headers

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

## Request body

- TypeSpacesGuidanceApiUpdateData
  - `options` TypeSpacesGuidanceOptions, required
    - `target` string, required
    - `trigger` 'first' | 'hover' | 'event' | 'manual', required
    - `type` 'sidebar' | 'popout' | 'tooltip', required
    - `role` 'admin' | 'guest'

## Response `200`

Response with status 200

- TypeSpacesGuidanceResource
  - `id` string, required — Guidance ID
  - `guideSlug` string, required
  - `options` TypeSpacesGuidanceOptions, required
    - `target` string, required
    - `trigger` 'first' | 'hover' | 'event' | 'manual', required
    - `type` 'sidebar' | 'popout' | 'tooltip', required
    - `role` 'admin' | 'guest'
  - `createdFrom` string — Guidance ID
  - `lastPropagatedAt` string, date-time — The last time the guidance template configuration was propagated to this guidance

## Other responses

- `400` — Error response with status 400
- `403` — Error response with status 403
- `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)