Sign in

v1

latestOpenAPI 3.1.12026-07-124448163.2 KB
collect.sessions

Submit a file to a collect session

Uploads a file submission for a collect item via a public token.

post/collect/sessions/{token}/submit/file

Path parameters

tokenstring required

The session token

Example:cs_live_cmll8jh7b00013b6tlu7lvntw

Response

File submitted successfully

idstring uuid required

The ID of the submission

statusstring required

The status of the submission

fileNamestring nullable required

The name of the uploaded file

fileSizenumber nullable required

The size of the uploaded file in bytes

fileMimeTypestring nullable required

The MIME type of the uploaded file

collectItemIdstring uuid required

The ID of the collect item

createdAtstring date-time required

The date and time the submission was created

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "fileName": "invoice.pdf",
  "fileSize": 1024,
  "fileMimeType": "application/pdf",
  "collectItemId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-01T00:00:00.000Z"
}