⚙️pdf_fill API parameters

Use all of our below options to personalize your pdf creation

API documentation: https://docmaker.co/API

Endpoint URL: https://api.v2.docmaker.co/pdf_fill

List of API call parameters:

Parameter Values enum Decription

Parameter	Values enum	Decription
`"templateID"`		ID of the docx template uploaded in your docmaker.co dashboard.
`"templateURL"`		As an alternative to the templateID, you may provide the full URL of your docx template file. Has to be a public file.
`"name"`		Name of the result file, has to include the extension (.pdf)
`"fontSize"`		Font size to be used to fill your pdf document
"`readOnly"`	`true, false`	Define whether the result file should remain editable (set to false) or if you want to create a non-editable file (set to true) .
`"minFontSize"`		In the case of multiline input, docMaker will automatically adjust the font size in order to make sure that the text data fits the box size. With the minFontSize parameter, you can define what is the minimum font size you want to accept for these fields.
`"metadata"`		Free text field, where you can store any useful data to identify a specific docMaker API call in the logs
`"upload_output_file"`	`true`,`false`	Boolean parameter, defining whether result files should be uploaded to docMaker S3 buckets (files are deleted after 48 hours). Should be set to true for most API calls. Except for Bubble.io, for which this can be set to false if you chose to upload the result file to Bubble (see Bubble plugins specific parameters).
`"privateUpload"`	`true`,`false`	Boolean parameter, if set to true, your result files will be uploaded to a private S3 bucket. You will get a presigend URL valid for 2 hours.
`"webhook_url"`		URL of the webhook where you want the result file to be sent.
`"webhook_token"`		You may provide an auth token in order to authenticate the webhook call to your server. docMaker will add it as a Beare token in the "Authorization" header of the webhook API call.
`"webhook_object_id"`		Free text field, which you can use to help your backend identifiy the object to which the docMaker result_file should be attached.
`"webhook_object_type"`		Free text field, which you can use to help your backend identifiy the table to which the docMaker result_file should be attached.
`"mailTo"`		List of email adresses (separated by comma) to receove the email
`"senderName"`		Sender's name, when using docMaker to send the created file in attachment to an email.
`"replyTo"`		reply to: email adress to be used when your users will reply to the message set by docMaker
`"ccTo"`		cc to: List of email adresses (separated by comma) to receive a copy of the email sent by docMaker
`"bccTo"`		bcc to: List of email adresses (separated by comma) to receive a blind copy of the email sent by docMaker
`"mailSubject"`		subject of the email
`"mailContent"`		email contents (html or text)
`"attachOutput"`	`true`, `false`	If true, the generated pdf will be attached ot the email
`"data"`		This field will contain all of the dynamic data to fill-out the pdf form.

"templateID"

ID of the docx template uploaded in your docmaker.co dashboard.

"templateURL"

As an alternative to the templateID, you may provide the full URL of your docx template file. Has to be a public file.

"name"

Name of the result file, has to include the extension (.pdf)

"fontSize"

Font size to be used to fill your pdf document

"readOnly"

true, false

Define whether the result file should remain editable (set to false) or if you want to create a non-editable file (set to true) .

"minFontSize"

In the case of multiline input, docMaker will automatically adjust the font size in order to make sure that the text data fits the box size. With the minFontSize parameter, you can define what is the minimum font size you want to accept for these fields.

"metadata"

Free text field, where you can store any useful data to identify a specific docMaker API call in the logs

"upload_output_file"

true,false

Boolean parameter, defining whether result files should be uploaded to docMaker S3 buckets (files are deleted after 48 hours). Should be set to true for most API calls. Except for Bubble.io, for which this can be set to false if you chose to upload the result file to Bubble (see Bubble plugins specific parameters).

"privateUpload"

true,false

Boolean parameter, if set to true, your result files will be uploaded to a private S3 bucket. You will get a presigend URL valid for 2 hours.

"webhook_url"

URL of the webhook where you want the result file to be sent.

"webhook_token"

You may provide an auth token in order to authenticate the webhook call to your server. docMaker will add it as a Beare token in the "Authorization" header of the webhook API call.

"webhook_object_id"

Free text field, which you can use to help your backend identifiy the object to which the docMaker result_file should be attached.

"webhook_object_type"

Free text field, which you can use to help your backend identifiy the table to which the docMaker result_file should be attached.

"mailTo"

List of email adresses (separated by comma) to receove the email

"senderName"

Sender's name, when using docMaker to send the created file in attachment to an email.

"replyTo"

reply to: email adress to be used when your users will reply to the message set by docMaker

"ccTo"

cc to: List of email adresses (separated by comma) to receive a copy of the email sent by docMaker

"bccTo"

bcc to: List of email adresses (separated by comma) to receive a blind copy of the email sent by docMaker

"mailSubject"

subject of the email

"mailContent"

email contents (html or text)

"attachOutput"

true, false

If true, the generated pdf will be attached ot the email

"data"

This field will contain all of the dynamic data to fill-out the pdf form.

PreviousBuild your pdf form NextPrint web page to pdf

Last updated 1 month ago