latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

Bulk upload supporting documents to multiple practitioners

Uploads one or more files exactly once each and links them as shared supporting-document attachments (source: "Bulk") to every selected practitioner. Practitioners may be selected explicitly via certifyPractitionerIds (JSON string form field), or via isSelectAll=true plus a filter JSON string (same encoding as GET /practitioners). When isSelectAll is true, certifyPractitionerIds is ignored; when false, filter is ignored. Target set size is capped (default 1000; see api-layer.practitioner.bulk-document-upload.max-practitioners). HTTP 200 is returned for both full and partial success: per-file and per-practitioner outcomes are reported independently in the response body. When the feature kill switch is off, the endpoint returns 404 with an empty body (CP-32986).

post/practitioners/supporting-documents/bulk

Headers

tenant-idstring required

Tenant identifier

Response

Bulk upload processed (full or partial success); see body for per-file and per-practitioner outcomes

batchIdstring

Unique identifier for this bulk upload batch

Example response

{
  "batchId": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "files": [
    {
      "originalFileName": "license.pdf",
      "status": "success"
    }
  ],
  "linkResults": {
    "failed": [
      {
        "certifyPractitionerId": "cp_abc123"
      }
    ]
  }
}