Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Note

Update the message on a credentialing workflow note

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.

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

Path parameters

noteIdstring required

ID of the note

workflowIdstring required

ID of the 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"
}