v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

CredentialingWorkflow

Update states to credential

Updates the states to credential for a credentialing workflow. Accepts an array of state codes (e.g., ["CA", "NY", "TX"]). An empty array [] will unset/remove the states to credential field.

patch/credentialing-workflows/{workflowId}/states-to-credential

Path parameters

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Request body

statesToCredentialstring[] required

The states to credential array. Empty array removes/unsets the states to credential.

reasonstring

Reason for the states to credential change

Example request

{
  "statesToCredential": [
    "CA",
    "NY",
    "TX"
  ],
  "reason": "Updated per request"
}

Response

Successfully updated the states to credential

object required