---
title: "Toggle Ai Response"
method: PATCH
path: "/engagements/{engagement_id}/ai-response"
tags: ["authenticated", "engagements"]
---

# Toggle Ai Response

`PATCH /engagements/{engagement_id}/ai-response`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/engagements/{engagement_id}/ai-response`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `engagement_id` string, required

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- ToggleAiResponseBody
  - `is_ai_allowed_to_respond` boolean, required
  - `user_id` string, nullable
  - `reason` string, nullable

## Response `204`

Successful Response

## Other responses

- `422`: Validation Error

---

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