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](/v2026-01-15/guides/lockbox-providers/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](/v2026-01-15/guides/lockbox-providers/mail-uploads) for details on the upload and rescan process.

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

location_idstringRequired

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

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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

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.

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

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

Successfully generated a presigned upload URL.

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

$	curl -X POST https://api.givechariot.com/v1/mailbox/upload_url \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"location_id": "po_543"
>	}'

$	curl -X POST https://api.givechariot.com/v1/mailbox/upload_url \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"location_id": "po_543"
>	}'

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