Notes

Partially update a work order note

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.

patch/workorders/{workorderId}/notes/{noteId}

Request

Path parameters

workorderIdinteger required

Unique numeric identifier of the work order.

noteIdinteger required

Unique numeric identifier of the note. To get the noteId, run the following method: GET/workorders/{workorderId}/notes. One note can be pinned to a single WO at a time.

Request body

IsPinnedboolean

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

The work order note was successfully patched.

Changes

No recorded changes to this operation across all 1 revision of this API.