---
title: "Partially update a work order note"
method: PATCH
path: "/workorders/{workorderId}/notes/{noteId}"
tags: ["Notes"]
---

# Partially update a work order note

`PATCH /workorders/{workorderId}/notes/{noteId}`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workorders/{workorderId}/notes/{noteId}`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workorders/:workorderId/notes/:noteId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates a work order note partially. For example, pins or unpins the work order note. For a successful request, returns the note ID in the response.
            <br />Available behind the *PinnedNotes* feature flag.

## Path parameters

- `workorderId` integer, required
- `noteId` integer, required

## Request body

- ServiceChannelServicesWebApiModelsRequestNotesPartialUpdateWorkOrderNoteRequest: Object for pinning/unpinning the work order note.
  - `IsPinned` boolean: Indicates whether the note should be pinned to the top of the notes list. Possible input values: • `true`: The note is pinned. • `false`: The note isn’t pinned.

## Response `200`

The work order note was successfully patched.

## Other responses

- `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 503 &mdash; Request data is empty 503 &mdash; Empty tracking number (workorder Id) 1301 &mdash; Request is empty or null
- `401`: The requested resource requires authentication. <br/>Error codes: 504 &mdash; API call rejected by security permissions
- `403`: You are not authorized to request this resource, or the resource is unavailable for some reason. <br/>Error codes: 100 &mdash; User has no rights to perform this action
- `404`: The requested resource does not exist on the server.
- `500`: Something went wrong, and the server was unable to complete your request.

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)