Bulk fill

Start a bulk fill

One filled PDF per row (≤ 5,000 rows), zipped in parts of 500. mapping is field name → column name. Returns a job (202); poll Retrieve a job or listen for bulk_job.completed. dryRun: true validates rows and previews file names without using quota.

post/v1/documents/{id}/bulk-fill/

Request

  • Base URL: https://api.pdfbetter.com
  • URL: https://api.pdfbetter.com/v1/documents/{id}/bulk-fill/
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Any unique string (≤ 255 chars). The first successful response is replayed for 24 hours for the same key and request.

Request body

rowsobject[] required
mappingobject required
fileNameTemplatestring
flattenboolean
dryRunboolean

Response

Start a bulk fill

object'job' required
idstring required
type'bulk_fill' required
documentIdstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
rowCountinteger required
doneCountinteger required
succeededCountinteger required
failedCountinteger required
progressinteger required

0–100

errorstring nullable required
createdAtstring required

ISO 8601 timestamp (UTC)

Changes

No recorded changes to this operation across all 1 revision of this API.