Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Note

Add a note to a credentialing workflow

Creates a new free-text note on the specified credentialing workflow. Use this to record annotations during the credentialing lifecycle; for facility workflows use the Facility Note create endpoint.

Preconditions: request body must contain a non-blank message field; no other fields are accepted. createdBy is set from the caller JWT.

Returns 201 with the created note. Not idempotent — each call creates a distinct note.

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

Created note, including server-assigned id and audit fields

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"
}