Upload multiple client documents (optional)

Use this endpoint to upload multiple files and their corresponding metadata in a single request instead of calling Upload client document multiple times.

Send a multipart/form-data request containing:

  • files: One file per part. Minimum 1 and maximum 6 files per request.
  • bulkMetadata: A JSON string containing metadata for each file. The number of entries in bulkMetadata.items must match the number of files parts. See ClientDocumentBulkMetadata.

Note Note:

  • You can upload between 1 and 6 files per request. The maximum supported file size is 200 MB per file. The maximum combined upload size is 250 MB. Supported file extensions are .jpg, .jpeg, .png, .pdf, .mp4, and .mov.

  • For error responses, inspect the response body for additional details:

    • 400 Bad Request returns a validationProblemDetails object, including an errors property that maps request fields to validation error messages.
    • All other error responses return a problemDetails object containing type, title, status, and detail.
Path Params
uuid
required

The unique identifier of the workflow.

Format: uuid

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

uuid
required

The unique client id for this client from the Create workflow response.

Format: uuid

Example: baa2bf19-5258-47ec-b428-276d3f045820

Body Params
files
array of files
required
length between 1 and 6

The files to upload. Send each file as a separate multipart part. Minimum 1, maximum 6 files per request.

Each file must have a matching entry in bulkMetadata.items (same count). Maximum 200 MB per file; combined maximum 1.2 GB per request.

Allowed extensions: .jpg, .jpeg, .png, .pdf, .mp4, .mov

bulkMetadata
object
required

The bulk upload metadata. In the multipart request, pass this object as a JSON string in the bulkMetadata form field.

Include one metadata entry in items per file in the files collection. The number of entries in items must equal the number of file parts (minimum 1, maximum 6 per request).

Each entry uses the same fields as Upload client document metadata (type, id, and any type-specific fields).

Headers
string
required
Defaults to Bearer <access_token>

The access_token returned in your most recent Create access token response.

string
Defaults to no-cache

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json