Update the message on a credentialing workflow note
PUT/credentialing-workflows/:workflowId/notes/:noteId
Updates the message field of an existing note on the specified credentialing workflow. Use this to correct or amend an annotation after it has been created.
Despite using HTTP PUT, this is a partial update: the service merges only the message into the existing note data; other note fields are preserved. Only message can be changed.
Preconditions: noteId must identify an existing note that belongs to the specified workflowId. Returns 400 for null/blank message or when the note belongs to a different workflow. Returns 404 when the note is not found.
updatedBy is set from the caller JWT. Not idempotent — each call refreshes updatedAt.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- 502
Updated note after message merge
Invalid request — blank or null message, or note belongs to a different workflow: validation failures return an ApiError (errors array); ownership mismatches and null-body errors return a BadRequestErrorResponse (errors string array)
Unauthorized - Authentication required
Forbidden - User does not have required permissions
Note not found
Internal Server Error - An unexpected error occurred
Downstream DAL failure (5xx ApiException). Mutating ops normalize to 502; GET ops forward the raw DAL status code.