---
title: "Patch Companion"
method: PATCH
path: "/api/v1/identities/{agent_handle}/companion"
tags: ["Identities"]
---

# Patch Companion

`PATCH /api/v1/identities/{agent_handle}/companion`

## Path parameters

- `agent_handle` string, required

## Request body

- CompanionUpdate
  - `enabled` boolean

## Response `200`

Successful Response

- CompanionConfigResponse
  - `notices` ResponseNotice[], nullable
    - `code` string, required
    - `level` string, required
    - `message` string, required
  - `enabled` boolean, required
  - `config_revision` integer, required
  - `readiness` object, required

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

## Changes

- **2026-09-22** `f3dcdb50fbaa` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/inkbox/apis/inkbox-api/changes/api/v1/identities/:agent_handle/companion/patch.md)

---

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