Delen via

Plumsail Documents

  • Reference

Plumsail Documents connector allows you to set up automated document generation and conversion. The connector provides a wide range of actions to manipulate PDF documents and PDF forms. Create documents from templates, convert to PDF, split and merge PDF files, protect them, read PDF forms, and more - all you need to automate documents in one connector. Find more information at https://plumsail.com/documents

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Support
URL https://plumsail.com
Email support@plumsail.com
Connector Metadata
Publisher Plumsail
Website https://plumsail.com
Privacy policy https://plumsail.com/privacy-policy/
Categories Productivity;Content and Files

Generate documents in Microsoft Power Automate, Azure Logic Apps or PowerApps

Register account

First of all, you need to register Plumsail Account. This account is used to manage Plumsail Documents, Plumsail Actions and Plumsail Forms products.

It is better to use your active email address. The subscription will be linked to this address.

If you already have an account, just sign in to account.plumsail.com.

Generate API key

You need to navigate to the "API Keys" section and click "Add new".

Once you created an API key, you can see your key right in the "Secret" column. You can also change a name of a key by clicking on it in the "Name" column:

API keys

Create as many keys as you need, for example, for using with different Power Automate (Microsoft Flow) accounts. If you don't need a key anymore you can delete it, please make sure that the key is not used anymore.

Now you can copy and use it in:

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring Get an API Key - https://plumsail.com/docs/documents/v1.x/user-guide/api-keys.html True

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds

Actions

Add a watermark to PDF

Add a watermark to PDF as text, an image, or PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf
Compress PDF document

Compress PDF document size if possible and optimize it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document
Convert Csv to Excel

Convert CSV to Excel file (XLXS). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel
Convert DOC to DOCX

Convert DOC to DOCX files. This action takes DOC document and converts it to DOCX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx
Convert DOCX to PDF

Convert DOCX to PDF files. This action takes DOCX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf
Convert HTML to PDF

Convert HTML to PDF file. This action takes HTML markup, renders it and converts to PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf
Convert Images to PDF

It takes images and converts them to a PDF document
Convert PDF to Image

Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image
Convert PDF to Image (deprecated) [DEPRECATED]

This action has been deprecated. Please use Convert PDF to Image instead.

Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image (deprecated)
Convert PPT to PPTX

Convert PPT to PPTX files. This action takes PPT document and converts it to PPTX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx
Convert PPTX to PDF

Convert PPTX to PDF files. This action takes PPTX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf
Convert XLS to XLSX

Convert XLS to XLSX files. This action takes XLS document and converts it to XLSX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx
Convert XLSX to PDF

Convert XLSX to PDF files. This action takes XLSX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf
Create document from DOCX template

Create document from DOCX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html
Create document from PPTX template

Create document from PPTX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html
Create document from XLSX template

Create document from XLSX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html
Create HTML from template

Create HTML takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template
Extract text from PDF document

Extract text from PDF takes PDF document and extracts text to Raw or HTML format. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document
Fill in PDF Form

Fill in PDF Form fills out PDF from by provided data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form
Fill merge fields in DOCX document

Fill merge fields in DOCX document takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document
Get Form from PDF

Get Form from PDF returns fillable form data from PDF as JSON. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf
Get information about PDF protection

Get information about PDF protection returns information whether the document is password protected. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information
Get Profile Info

Get Profile Info returns information about current user and license.
Merge Docx

Merge Docx takes an array of Docx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx
Merge PDF

Merge PDF takes an array of PDF documents and merge it into one. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-pdf
Parse CSV

Parse CSV works like Parse JSON but for CSV files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv
Protect PDF document

Protect PDF document adds passwords, copy, printing, and other protections to PDF files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document
Regular Expression Match

Regular Expression Match searches for an input string for all occurrences of a regular expression and returns all the matches. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match
Regular Expression Replace

Regular Expression Replace replaces all strings that match a regular expression pattern with a specified replacement string in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace
Regular Expression Test

Regular Expression Test indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test
Split PDF

Split PDF takes PDF document and splits it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf
Split PDF (deprecated) [DEPRECATED]

This action has been deprecated. Please use Split PDF instead.

It takes a PDF document and splits it (deprecated)
Start document generation process

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process
Start document generation process with json

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json

Add a watermark to PDF

Operation ID:
FlowV1DocumentsJobsAddWatermarkToPdfPost

Add a watermark to PDF as text, an image, or PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf

Parameters

Name Key Required Type Description
Type
 type True string

The type of the watermark
request
 request True dynamic

Returns

Body
DocumentProcessingResponse

Compress PDF document

Operation ID:
FlowV1DocumentsJobsCompressPdfPost

Compress PDF document size if possible and optimize it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Password
 password string

Password to open PDF file

Returns

Result file
binary

Convert Csv to Excel

Operation ID:
FlowV1DocumentsJobsCsv2XlsxPost

Convert CSV to Excel file (XLXS). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel

Parameters

Name Key Required Type Description
Content of CSV document
 content True byte

Content of CSV document
Delimiter
 delimiter string

Delimiter of columns (by default it is just comma)
Locale
 locale string

The locale that will be applyed to the document
Limit
 limit integer

Returns the first "n" rows
Use first line as headers
 hasHeaderRecords boolean

If set to "Yes" then headers will be read from the first line.
CSV column name or index
 csvColumnIndexOrName True string

CSV column name or column index (1, 2, etc.)
XLSX column type
 xlsxColumnType string

Optional. Column type (ShortDateTime, TwoDecimal, etc.)
XLSX column name
 xlsxColumnName string

Optional. Rename CSV column to this name

Returns

Result file
binary

Convert DOC to DOCX

Operation ID:
FlowV1DocumentsJobsDoc2DocxPost

Convert DOC to DOCX files. This action takes DOC document and converts it to DOCX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert DOCX to PDF

Operation ID:
FlowV1DocumentsJobsDocx2PdfPost

Convert DOCX to PDF files. This action takes DOCX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Body
DocumentProcessingResponse

Convert HTML to PDF

Operation ID:
FlowV1DocumentsJobsHtml2PdfPost

Convert HTML to PDF file. This action takes HTML markup, renders it and converts to PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf

Parameters

Name Key Required Type Description
Source HTML
 html True string

HTML markup that should be converted to PDF
Engine
 engine string

Conversion engine
Paper Size
 size string

Can be A4,A5 etc...
Orientation
 orientation string

Portrait vs Landscape
Margins
 margins string

The page margins. The syntax is the same as in CSS. Example: 25 50 75 100.
Header HTML
 headerHtml string

Only Classic engine - HTML markup that should be added as a header
Footer HTML
 footerHtml string

Only Classic engine - HTML markup that should be added as a footer

Returns

Body
DocumentProcessingResponse

Convert Images to PDF

Operation ID:
FlowV1DocumentsJobsImage2PdfPost

It takes images and converts them to a PDF document

Parameters

Name Key Required Type Description
Single image per page
 imagePerPage boolean

Select "No" if you don't want each image to be on a separate page. Default is "Yes"
Image content
 imageContent True array of byte

Raw content of the image

Returns

Result file
binary

Convert PDF to Image

Operation ID:
FlowV1DocumentsJobsPdf2ImageV2Post

Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Filename Prefix
 filenamePrefix string

Optional. Output files will have this prefix followed by an index number for name
Start Page
 startPage integer

The first page to start extraction (1 based)
End Page
 endPage integer

The last page to extract (inclusive)
Pages
 pages string

Page numbers for extraction separated by ';' (only this pages will be extracted)
Image Format
 format string

The format of the result image
DPI
 dpi integer

The resolution of the result image
Password
 password string

Password to decrypt document

Returns

Body
DocumentsWithFilenamesResponse

Convert PDF to Image (deprecated) [DEPRECATED]

Operation ID:
FlowV1DocumentsJobsPdf2ImagePost

This action has been deprecated. Please use Convert PDF to Image instead.

Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image (deprecated)

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Start Page
 startPage integer

The first page to start extraction (1 based)
End Page
 endPage integer

The last page to extract (inclusive)
Pages
 pages string

Page numbers for extraction separated by ';' (only this pages will be extracted)
Image Format
 format string

The format of the result image
DPI
 dpi integer

The resolution of the result image
Password
 password string

Password to decrypt document

Returns

Body
DocumentsArrayResponse

Convert PPT to PPTX

Operation ID:
FlowV1DocumentsJobsPpt2PptxPost

Convert PPT to PPTX files. This action takes PPT document and converts it to PPTX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert PPTX to PDF

Operation ID:
FlowV1DocumentsJobsPptx2PdfPost

Convert PPTX to PDF files. This action takes PPTX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert XLS to XLSX

Operation ID:
FlowV1DocumentsJobsXls2XlsxPost

Convert XLS to XLSX files. This action takes XLS document and converts it to XLSX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Convert XLSX to PDF

Operation ID:
FlowV1DocumentsJobsXslx2PdfPost

Convert XLSX to PDF files. This action takes XLSX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Content of document that should be converted

Returns

Result file
binary

Create document from DOCX template

Operation ID:
FlowV1DocumentsJobsApplyDocxTemplatePost

Create document from DOCX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html

Parameters

Name Key Required Type Description
Template file
 documentContent True binary

Content of the template
Template data
 data True object

JSON data that should be applied to the template
Document output type
 outputType True string

The required document type
Locale
 locale string

The locale that will be applyed to the document
Time zone
 timezone string

The time zone of the document

Returns

Result file
binary

Create document from PPTX template

Operation ID:
FlowV1DocumentsJobsApplyPptxPost

Create document from PPTX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html

Parameters

Name Key Required Type Description
Template file
 documentContent True binary

Content of the template
Template data
 data True object

JSON data that should be applied to the template
Document output type
 outputType True string

The required document type
Locale
 locale string

The locale that will be applyed to the document
Time zone
 timezone string

The time zone of the document

Returns

Body
DocumentProcessingResponse

Create document from XLSX template

Operation ID:
FlowV1DocumentsJobsApplyXlsxTemplatePost

Create document from XLSX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html

Parameters

Name Key Required Type Description
Template file
 documentContent True binary

Content of the template
Template data
 data True object

JSON data that should be applied to the template
Document output type
 outputType True string

The required document type
Locale
 locale string

The locale that will be applyed to the document
Time zone
 timezone string

The time zone of the document

Returns

Result file
binary

Create HTML from template

Operation ID:
FlowV1DocumentsJobsApplyHtmlPost

Create HTML takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template

Parameters

Name Key Required Type Description
Source HTML
 html True byte

Text HTML template or HTML file template
Template data
 data True object

JSON data that should be applied to the template
Locale
 locale string

The locale that will be applyed to the document
Time zone
 timezone string

The time zone of the document

Returns

Body
ApplyHtmlTemplateResponse

Extract text from PDF document

Operation ID:
FlowV1DocumentsJobsExtractTextFromPdfPost

Extract text from PDF takes PDF document and extracts text to Raw or HTML format. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Start Page
 startPage integer

The first page to start extraction (1 based)
End Page
 endPage integer

The last page to extract (inclusive)
Result Type
 resultType string

Raw or HTML
Password
 password string

Password to decrypt document

Returns

Body
DocumentProcessingResponse

Fill in PDF Form

Operation ID:
FlowV1DocumentsJobsFillInPdfFormPost

Fill in PDF Form fills out PDF from by provided data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
JSON data
 jsonData True object

The data that will be used to fill out the form
Lock form fields
 lockFormFields boolean

Disable fields editing after filling them
Password
 password string

Password to open PDF file

Returns

Body
DocumentProcessingResponse

Fill merge fields in DOCX document

Operation ID:
FlowV1DocumentsJobsApplyDocxPost

Fill merge fields in DOCX document takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document

Parameters

Name Key Required Type Description
DOCX document content
 docxDocument True byte

Raw content of docx document template. MergeField names should be the same as keys in template data
Template data
 data True object

JSON data that should be applied to the template

Returns

Body
DocumentProcessingResponse

Get Form from PDF

Operation ID:
FlowV1DocumentsJobsGetPdfFormPost

Get Form from PDF returns fillable form data from PDF as JSON. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Password
 password string

Password to decrypt document

Returns

response
object

Get information about PDF protection

Operation ID:
FlowV1DocumentsJobsGetPdfProtectionInfoPost

Get information about PDF protection returns information whether the document is password protected. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document

Returns

Body
GetPdfProtectionInfoResponse

Get Profile Info

Operation ID:
ProfilesMeGet

Get Profile Info returns information about current user and license.

Returns

Body
ProfileInfo

Merge Docx

Operation ID:
FlowV1DocumentsJobsMergeDocxPost

Merge Docx takes an array of Docx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx

Parameters

Name Key Required Type Description
Content
 documentsContents True array of binary

The array of raw content of Docx documents
Apply header and footer
 applyHeaderAndFooter True boolean

Applies the header and footer from the first document to all the others

Returns

Body
DocumentProcessingResponse

Merge PDF

Operation ID:
FlowV1DocumentsJobsMergePdfPost

Merge PDF takes an array of PDF documents and merge it into one. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-pdf

Parameters

Name Key Required Type Description
Content
 documentsContents True array of binary

The array of raw content of PDF documents

Returns

Result file
binary

Parse CSV

Operation ID:
FlowV1DocumentsJobsParseCsvPost

Parse CSV works like Parse JSON but for CSV files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv

Parameters

Name Key Required Type Description
Content of CSV document
 content True byte

Content of CSV document
Delimiter
 delimiter string

Delimiter of columns (by default it is just comma)
Locale
 locale string

The locale that will be applyed to the document
Limit
 limit integer

Returns the first "n" rows
Headers
 headers True string

Comma separated list of headers in the same order as CSV columns
Skip first line
 skipFirstLine boolean

Select "Yes" if your CSV has headers as a first line.

Returns

The outputs of this operation are dynamic.

Protect PDF document

Operation ID:
FlowV1DocumentsJobsProtectPdfPost

Protect PDF document adds passwords, copy, printing, and other protections to PDF files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Enable printing
 allowPrinting True boolean

Protect the PDF file from being printed out
Enable modification
 allowModification True boolean

Protect the PDF file from being edited
Enable extract data
 allowExtract True boolean

Allows extraction of text, images, and other media from the PDF file
Enable annotate
 allowAnnotate True boolean

Allows annotation (e.g. comments, form fill-in, signing) of the PDF file
PDF owner password
 newOwnerPassword string

Enter an optional owner password here. This password can be used to disable document restrictions
PDF user password
 newUserPassword string

Enter an optional user password here. Each time an user opens the PDF he will be asked for this password. If you do not want a password prompt then leave this field blank
Password
 password string

Password to decrypt document

Returns

Body
DocumentProcessingResponse

Regular Expression Match

Operation ID:
FlowV1DocumentsJobsRegExpMatchPost

Regular Expression Match searches for an input string for all occurrences of a regular expression and returns all the matches. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match

Parameters

Name Key Required Type Description
Pattern
 pattern True string

Regular expression pattern
Text
 text True string

String to search for matches

Returns

The outputs of this operation are dynamic.

Regular Expression Replace

Operation ID:
FlowV1DocumentsJobsRegExpReplacePost

Regular Expression Replace replaces all strings that match a regular expression pattern with a specified replacement string in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace

Parameters

Name Key Required Type Description
Pattern
 pattern True string

Regular expression pattern
Text
 text True string

String to search for matches
Replacement
 replacement string

Replacement string

Returns

Body
StringResultResponse

Regular Expression Test

Operation ID:
FlowV1DocumentsJobsRegExpTestPost

Regular Expression Test indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test

Parameters

Name Key Required Type Description
Pattern
 pattern True string

Regular expression pattern
Text
 text True string

String to search for matches

Returns

Body
BooleanResultResponse

Split PDF

Operation ID:
FlowV1DocumentsJobsSplitPdfV2Post

Split PDF takes PDF document and splits it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf

Parameters

Name Key Required Type Description
Type of split
 type True string

How to split the file
request
 request True dynamic

Returns

Body
DocumentsWithFilenamesResponse

Split PDF (deprecated) [DEPRECATED]

Operation ID:
FlowV1DocumentsJobsSplitPdfPost

This action has been deprecated. Please use Split PDF instead.

It takes a PDF document and splits it (deprecated)

Parameters

Name Key Required Type Description
Document content
 documentContent True byte

Raw content of PDF document
Start Page
 startPage integer

The first page to start split (1 based)
End Page
 endPage integer

The last page to split (inclusive)
Split At Page
 splitAtPage integer

Number of pages per partition
Password
 password string

Password to decrypt document

Returns

Body
DocumentsArrayResponse

Start document generation process

Operation ID:
FlowV1ProcessesFlowJobsExecuteProcessWithGeneratedDataPost

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process

Parameters

Name Key Required Type Description
Process name
 processId True string

The name of process to be started
data
 data True dynamic

Returns

Result file
binary

Start document generation process with json

Operation ID:
FlowV1ProcessesFlowJobsExecuteProcessPost

Start document generation process fills a DOCX, XLSX, PPTX or PDF template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json

Parameters

Name Key Required Type Description
Process name
 processId True string

The name of process to be started
object

Returns

Result file
binary

Triggers

Process finished

Creates a webhook that runs when the process is finished

Process finished

Operation ID:
FlowV1ProcessesFlowTriggersPost

Creates a webhook that runs when the process is finished

Parameters

Name Key Required Type Description
Process name
 processId True string

The name of process to be started

Returns

The outputs of this operation are dynamic.

Definitions

ApplyHtmlTemplateResponse

Name Path Type Description
Result HTML
 htmlResult string

Raw HTML result

BooleanResultResponse

Name Path Type Description
IsSuccess
 isSuccess boolean

DocumentContentWithFilename

Name Path Type Description
Filename
 filename string

Name of the file
File Content
 fileContent byte

File content

DocumentProcessingResponse

Name Path Type Description
Result file
 fileContent byte

The result as a file

DocumentsArrayResponse

Name Path Type Description
Result files
 resultFilesContents array of byte

The array of raw content of result files

DocumentsWithFilenamesResponse

Name Path Type Description
Result files
 resultFiles array of DocumentContentWithFilename

Array of raw contents of result files with their filenames

GetPdfProtectionInfoResponse

Name Path Type Description
isPasswordProtected
 isPasswordProtected boolean

LicenseInfo

Name Path Type Description
type
 type integer
credits
 credits integer
additionalCredits
 additionalCredits integer
expirationDate
 expirationDate date-time

ProfileInfo

Name Path Type Description
name
 name string
email
 email string
licenseStatus
 licenseStatus string
teamName
 teamName string
licenseInfo
 licenseInfo LicenseInfo
shortUserId
 shortUserId string

StringResultResponse

Name Path Type Description
Result
 result string

binary

This is the basic data type 'binary'.

object

This is the type 'object'.