Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
CredentialingWorkflow

Update a timeline event and workflow in batch

Updates specific fields of an existing timeline event and its associated workflow in a single atomic transaction. Supports partial updates of nextCredentialingDate, nextCredentialingDateSource, changeReason, and nextCredentialingDateChangeLog fields. Only works with CRED_APPROVED timeline events. Both timeline and workflow are updated in a single transaction batch for data consistency.

patch/credentialing-workflows/{workflowId}/timeline-events/{eventId}

Path parameters

eventIdstring required

ID of the timeline event to update

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

nextCredentialingDatestring date
nextCredentialingDateSourcestring
changeReasonstring

Example request

{
  "nextCredentialingDate": "2022-03-10",
  "nextCredentialingDateChangeLog": [
    {
      "changedFrom": "2022-03-10",
      "changedTo": "2022-03-10"
    }
  ]
}

Response

Successfully updated the timeline event

idstring

Unique identifier for the timeline event

workflowIdstring

ID of the associated credentialing workflow

createdBystring

ID of the user who created the timeline event

updatedBystring

ID of the user who last updated the timeline event

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "te_123456",
  "workflowId": "cw_123456",
  "data": {
    "name": "CRED_APPROVED",
    "changeReason": "Application approved by committee",
    "credentialingDecisionDate": "2022-03-10",
    "nextCredentialingDate": "2022-03-10",
    "nextCredentialingDateSource": "SYSTEM_CALCULATED",
    "nextCredentialingDateChangeLog": [
      {
        "changedFrom": "2022-03-10",
        "changedTo": "2022-03-10",
        "changeReason": "Updated based on new license expiration",
        "createdBy": "user_123456",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "psvPdfPath": "/files/psv_123456.pdf",
    "overrideReason": "Test override reason",
    "isOverride": true
  },
  "createdBy": "user_123456",
  "updatedBy": "user_123456",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}