latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

Replace all supporting documents for a practitioner

Replaces the practitioner's entire supporting-documents array with the submitted list; this is a full-array replace, not a per-item action-based update — there is no action or document-id field in the request, and every submitted item is persisted as the new array. To remove a document, resubmit the array without it; to add a new document without resubmitting the whole array, use POST /practitioners/{id}/supporting-documents instead. {id} is the certifyPractitionerId.

put/practitioners/{id}/supporting-documents

Path parameters

idstring required

Practitioner ID

Headers

tenant-idstring

Request body

fileUrlstring required

URL of the supporting document file

fileTypestring

Type of the supporting document

originalFileNamestring

Original name of the uploaded file

createdAtstring date

createdBystring

Email of the user who created the document

statestring

State associated with the document

expirationDatestring date

sourcestring

Source of the document

Example request

[
  {
    "fileUrl": "https://storage.example.com/documents/certificate.pdf",
    "fileType": "PDF",
    "originalFileName": "medical_license.pdf",
    "createdBy": "user@example.com",
    "state": "CA",
    "source": "manual"
  }
]

Response

Confirmation message that the supporting documents were replaced.