Sign in

v31

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215985245.8 KB
mailbox

Get a Batch Upload URL

Returns a presigned URL for uploading a mailbox batch.

A batch is a ZIP file containing TIFF images and a CSV index file. The CSV must conform to the Batch Format specification.

The location_id must match the format po_<number> (e.g., po_543). The returned URL is a presigned S3 URL valid for 15 minutes. Upload the batch ZIP file using an HTTP PUT request to this URL.

See the Mail Uploads guide for details on the upload and rescan process.

post/v1/mailbox/upload_url

Request body

location_idstring required

The identifier of the PO box or lockbox location. Must match the format po_<number>.

Example request

{
  "location_id": "po_543"
}

Response

Successfully generated a presigned upload URL.

urlstring

The presigned URL to upload the batch ZIP file to via HTTP PUT. Expires after 15 minutes.

Example response

{
  "url": "https://storage.example.com/upload?token=abc123"
}