Formstack Documents

App · 24 actions

Create document templates and data routes, merge data, and convert or process PDF files.

Actions

ActionWhat it does
CombineCombine.
Compress pdfCompress pdf.
Convert to pdfConvert to pdf.
Copy documentCopy document.
Create documentCreate document.
Create routeCreate route.
Delete documentDelete document.
Delete routeDelete route.
Download templateRetrieve the uploaded source template as base64, with its file type and last update time.
Encrypt pdfEncrypt pdf.
Get documentGet document.
Get routeGet route.
List document deliveriesList document deliveries.
List document fieldsList document fields.
List documentsList documents.
List route deliveriesList route deliveries.
List route fieldsList route fields.
List route rulesList route rules.
List routesList routes.
Merge documentMerge document.
Merge routeMerge route.
Split pdfSplit pdf.
Update documentUpdate document.
Update routeUpdate route.

Combine

Combine.

Inputs

FilesfileslistRequired
Files.
OutputoutputtextRequired
Output.One of: pdf, docx.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Compress pdf

Compress pdf.

Inputs

FilefileobjectRequired
Name plus either a public URL or base64 contents.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Convert to pdf

Convert to pdf.

Inputs

FilefileobjectRequired
Name plus either a public URL or base64 contents.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Copy document

Copy document.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.
NamenametextRequired
Name.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}

Create document

Create document.

Inputs

NamenametextRequired
Name.
TypetypetextRequired
Type.One of: html, pdf, docx, xlsx, pptx.
OutputoutputtextRequired
Output.One of: pdf, docx, xlsx, pptx, email.
Htmlhtmltext
Html.
File urlfile_urltext
File url.
File contentsfile_contentstext
File contents.
Output nameoutput_nametext
Output name.
Folderfoldertext
Folder.
Size widthsize_widthnumber
Size width.At least 0.
Size heightsize_heightnumber
Size height.At least 0.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}

Create route

Create route.

Inputs

NamenametextRequired
Name.
RulesruleslistRequired
Rules.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}

Delete document

Delete document.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": 1
  }
}

Delete route

Delete route.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": 1
  }
}

Download template

Retrieve the uploaded source template as base64, with its file type and last update time.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.

Outputs

dataobject
The uploaded template file.
Example output
{
  "data": {
    "contents": "example",
    "last_update": "example",
    "type": "example"
  }
}

Encrypt pdf

Encrypt pdf.

Inputs

FilefileobjectRequired
Name plus either a public URL or base64 contents.
PasswordpasswordtextRequired
Password.
User passworduser_passwordtext
User password.
Permissionspermissionslist
Permissions.One or more of: Printing, DegradedPrinting, ModifyContents, Assembly, CopyContents, FillIn, AllFeatures.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Get document

Get document.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}

Get route

Get route.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}

List document deliveries

List document deliveries.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List document fields

List document fields.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List documents

List documents.

Inputs

Searchsearchtext
Search.
Folderfoldertext
Folder.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List route deliveries

List route deliveries.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List route fields

List route fields.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List route rules

List route rules.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

List routes

List routes.

Inputs

None.

Outputs

datalist
Returned value.
Example output
{
  "data": []
}

Merge document

Merge document.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.
DatadataobjectRequired
Data.
Testtesttrue/false
Test.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": 1
  }
}

Merge route

Merge route.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.
DatadataobjectRequired
Data.
Testtesttrue/false
Test.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "success": 1
  }
}

Split pdf

Split pdf.

Inputs

FilefileobjectRequired
Name plus either a public URL or base64 contents.
Extractextracttext
Page ranges to extract, for example 1-3,5.
Removeremovetext
Page ranges to remove.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Update document

Update document.

Inputs

Documentdocument_idtextRequired
Choose a document or use its ID.
Namenametext
Name.
Outputoutputtext
Output.One of: pdf, docx, xlsx, pptx, email.
Htmlhtmltext
Html.
File urlfile_urltext
File url.
File contentsfile_contentstext
File contents.
Output nameoutput_nametext
Output name.
Folderfoldertext
Folder.
Size widthsize_widthnumber
Size width.At least 0.
Size heightsize_heightnumber
Size height.At least 0.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}

Update route

Update route.

Inputs

Routeroute_idtextRequired
Choose a data route or use its ID.
Namenametext
Name.
Rulesruleslist
Rules.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}

On this page