---
title: "PATCH /GroupVisits/{appointmentId}/soap/{soapId}"
method: PATCH
path: "/GroupVisits/{appointmentId}/soap/{soapId}"
tags: ["GroupVisits"]
---

# PATCH /GroupVisits/{appointmentId}/soap/{soapId}

`PATCH /GroupVisits/{appointmentId}/soap/{soapId}`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/GroupVisits/{appointmentId}/soap/{soapId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/GroupVisits/:appointmentId/soap/:soapId/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `appointmentId` string, required
- `soapId` string, required

## Request body

- UpdateGroupSoapNoteRequest
  - `subjective` string, nullable
  - `objective` string, nullable
  - `assessment` string, nullable
  - `plan` string, nullable
  - `cohortLabel` string, nullable

## Response `200`

OK

- GroupSoapNoteDto
  - `id` string
  - `subjective` string
  - `objective` string
  - `assessment` string
  - `plan` string
  - `cohortLabel` string, nullable
  - `status` string
  - `format` string: Note-format discriminator (PAW-744). A group visit's AI-generated note comes from the same generation path as a patient visit's, so it inherits the appointment type's note format — including single-section formats, whose whole body lives in `Subjective`. The editor needs this to avoid labelling that body "Subjective" beside three empty boxes.
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `exceptions` MemberExceptionDto[]
    - `id` string
    - `soapNoteId` string
    - `patientGroupMemberId` string
    - `memberDisplayName` string
    - `exceptionNote` string
    - `differentTreatment` boolean
    - `followUpNeeded` boolean
    - `createdAt` string, date-time

## Changes

- **2026-08-07** `a905bde4e796`: 3 info
  - added the optional property `format` to the response with the `200` status (media type: text/plain)
  - added the optional property `format` to the response with the `200` status (media type: application/json)
  - added the optional property `format` to the response with the `200` status (media type: text/json)

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/GroupVisits/:appointmentId/soap/:soapId/patch.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)