Add An Insert

  1. API Docs
  2. Inserts
  3. Add An Insert

Uploads a new insert. Send a multipart/form-data request with the PDF and its metadata. The insert becomes available immediately for use in the insert field of payment calls (see Add A Payment).

Alias: POST /v1/insert/create accepts the identical payload. A successful upload responds with HTTP 201 and the created insert object.

Parameters
Parameter Type Required Default Description
file File Yes N/A The insert PDF. Must be a valid, non-encrypted PDF of 20 MB or less.
name String Yes N/A Display name of the insert (max 255 characters).
description String No N/A Optional description; defaults to the uploaded filename when omitted.
is_color Boolean No false Whether the insert prints in color.
duplex Boolean No false Whether the insert prints double-sided.
Sample Response
{
  "insert": {{
  "id": 42,
  "client_id": 1100,
  "company_name": "Demo Company",
  "name": "Product Brochure",
  "description": "Product Brochure",
  "is_color": false,
  "duplex": false,
  "pages": 2,
  "deleted": false,
  "stored_file_id": 3112,
  "download_url": "/clients/1100/inserts/42/download",
  "created_at": "2026-09-05 10:00:00",
  "updated_at": "2026-09-05 10:00:00",
  "deleted_at": null
}}
}