docx_fill_convert API parameters
Use all of our below options to personalize your pdf creation.
Last updated
Use all of our below options to personalize your pdf creation.
Last updated
API documentation:
Endpoint URL: https://api.v2.docmaker.co/docx_fill_convert
"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 or .docx)
"pdfEngine"
"custom", "standard"
"custom" pdf engine is faster but restricted to open source fonts (mostly google fonts) "standard" pdf engine accepts most standard fonts
"outputType"
"pdf", "docx"
Define the format of the result file: docMaker can generate either docx or pdf files
"emptyTags"
"removeTags",
"leaveTags",
"undefined",
"N/A"
"removeTags": if no data is sent to replace a specific substitution tag, then the tag will be removed "leaveTags": if no data, tag will remain in the document. Useful when creating custom templates with your app. "undefined": if no data, tags will be replaced by "undefined" "N/A": if no data, tags will be replaced by "N/A"
"showJSONinLogs"
true,
false
Boolean parameter, if set to "no", then none of your data will be stored in docMaker servers, not event in technical logs
"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 "yes" for most API calls. Except for Bubble.io, for which this can be set to "yes" if you chose to upload the result file to Bubble (see Bubble plugins specific parameters).
"privateUpload"
true,false
Boolean parameter, if set to "yes", 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