v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Note

Create a note for a credentialing workflow

Creates a new note for the specified credentialing workflow

post/credentialing-workflows/{workflowId}/notes

Path parameters

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

messagestring required

Response

Successfully created the note

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": "note_123456",
  "workflowId": "cw_123456",
  "data": {
    "message": "This is a note message"
  },
  "createdBy": "user_123456",
  "createdByName": "John Doe",
  "updatedBy": "user_123456",
  "updatedByName": "Jane Smith",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}