Skip to main content

Update one record in a section of a facility workflow

PATCH 

/facility-credentialing-workflows/:workflowId/:section/:index

Merges the request body onto the record at the given position in the named section of the specified facility credentialing workflow and leaves every other record as it is. When to use: Use this to edit a single record (for example one state license) without resending the whole section. Fields the body leaves out keep their stored value; a field the body sends as null is removed from the stored record, which is how an optional field is cleared. The body is validated against the same rules as one element of that section's replace-all PUT, so the section's required fields must be present and cannot be null; stored records that are incomplete do not block the save. If the record's content changes, its verification is cleared; verification fields in the body are ignored. Preconditions: The workflow must belong to the caller's tenant. index is the record's 0-based position in the section. Supported sections: specialties, licenses, liability-insurance, sanctions, accreditations, certificates, npdb-reports, site-visits, medicare-star-ratings, app-verifications, performance-indicators, addresses, emails, phone-numbers. Returns: 200 OK with the workflow ID, the section, the index and a message. Returns 400 if the section is unknown, the index is not a non-negative integer inside the section, or the record is invalid, 404 if the workflow is not found.

Request​

Responses​

Record updated successfully