---
title: "Update Playbook Instance"
method: PUT
path: "/api/v1/playbooks/instances/{instance_id}"
tags: ["playbooks"]
---

# Update Playbook Instance

`PUT /api/v1/playbooks/instances/{instance_id}`

## Request

- Base URL: `https://geo.sig.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://geo.sig.ai/api/v1/playbooks/instances/{instance_id}`
- Auth: HTTP bearer

Update playbook instance status/notes.

## Path parameters

- `instance_id` string, uuid, required

## Cookies

- `access_token` string, nullable

## Request body

- PlaybookInstanceUpdate: Update playbook instance.
  - `status` string, nullable
  - `notes` string, nullable

## Response `200`

Successful Response

- PlaybookInstanceResponse: Playbook instance response.
  - `id` string, uuid, required
  - `playbook_id` string, uuid, required
  - `run_id` string, uuid, required
  - `intent_id` string, required
  - `status` string, required
  - `notes` string, nullable, required
  - `completed_at` string, date-time, nullable, required
  - `created_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/sig/apis/ai-visibility-intelligence-api.md) · [All operations](https://skmtc.dev/sig/apis/ai-visibility-intelligence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sig/apis/ai-visibility-intelligence-api/revisions/3ec39f9be9e0?raw)