Create or send a template PDF document

post

https://sapi.boloforms.com/signature/pdf-template-lambda

Create / send a template PDF document for signing (also supports form templates).

This is the public route for creating a signing request from a template. Set signingType to PDF_TEMPLATE to send a PDF template, or FORM_TEMPLATE to send a form template. Supply receivers, optional custom variables, and optional mailData.

For PDF_TEMPLATE, each receiver roleTitle must exactly match a role on the template in the BoloSign dashboard. The createdDocumentId in the PDF response is the Mongo ObjectId to pass as responseId to /void-document and /send-reminder when documentType=PDF_TEMPLATE.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customVariables

array of objects

length ≤ 1000

Optional: Custom variables to be replaced in the template

customVariables

mailData

object

documentId

string

required

length between 1 and 128

^[A-Za-z0-9_-]{1,128}$

ID of the document template

signingType

string

enum

required

length between 12 and 12

^(PDF_TEMPLATE)$

Must be PDF_TEMPLATE

Allowed:

receiversList

array of objects

required

length between 1 and 100

List of receivers who need to sign the document. roleTitle values must be unique.

receiversList*

pdfData

string

length between 28 and 20971520

^data:application\/pdf;base64,[A-Za-z0-9+/=\s]+$

Base64-encoded PDF data. You can send a different PDF while maintaining the template's field mappings. For example, if your template has 50 pages with signature fields, you can send a 30-page PDF that follows the same format. The system will automatically map fields to correct locations based on the original template, saving time by reusing the existing field configuration.

Responses

200Successfully created / sent the template PDF (or form) for signing

400Bad Request - Invalid parameters, workspace access, or document state

401Unauthorized - API key is missing

404Not Found

500Internal Server Error