latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace user-defined fields on a facility workflow

Replaces the entire userDefinedFields object on the specified facility credentialing workflow with the object provided in the request body (replace-all / RESTful PUT semantics). When to use: Use to set or update custom metadata for a workflow. Omitting a key removes it. To clear all user-defined fields, send an empty object {}. Constraints: This field cannot be modified once the workflow reaches a completed or invalid status — a 400 Bad Request is returned in that case (WorkflowCompletedException or WorkflowStatusInvalidException). Schema: Returns: 200 OK. Returns 400 if the workflow is in a terminal status or if the input is otherwise invalid.

put/facility-credentialing-workflows/{workflowId}/userdefinedfields

Path parameters

workflowIdstring required

Facility credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

object required

User defined fields object with custom properties

Response

User defined fields updated successfully

object required