Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility Note

Update the message on a facility credentialing workflow note

Updates the message of an existing note on the specified facility credentialing workflow. Use this to correct or revise previously created note text.

Despite using HTTP PUT, this is a partial update: only the message field is merged; all other note fields are preserved.

Preconditions: noteId must identify an existing note that belongs to the specified workflowId. Returns 400 for blank/missing message or ownership mismatch. Returns 404 when the note is not found.

Not idempotent — each call refreshes updatedAt.

put/facility-credentialing-workflows/{workflowId}/notes/{noteId}

Path parameters

noteIdstring required

ID of the note

workflowIdstring required

ID of the facility credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

messagestring required

Response

Updated note after message merge

idstring

Unique identifier for the note

workflowIdstring

ID of the associated credentialing workflow

createdBystring

ID of the user who created the note

createdByNamestring

Full name of the user who created the note

updatedBystring

ID of the user who last updated the note

updatedByNamestring

Full name of the user who last updated the note

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "44444444-4444-4444-8444-444444444444",
  "workflowId": "22222222-2222-4222-8222-222222222222",
  "data": {
    "message": "This is a note message"
  },
  "createdBy": "55555555-5555-4555-8555-555555555555",
  "createdByName": "Example Analyst",
  "updatedBy": "55555555-5555-4555-8555-555555555555",
  "updatedByName": "Example Analyst",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}