# Formstack Documents

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

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/formstack-documents

## Actions

### Combine

Combine.

**Inputs**

- Files (`files`, list, required): Files.
- Output (`output`, text, required): Output. One of: `pdf`, `docx`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Compress pdf

Compress pdf.

**Inputs**

- File (`file`, object, required): Name plus either a public URL or base64 contents.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Convert to pdf

Convert to pdf.

**Inputs**

- File (`file`, object, required): Name plus either a public URL or base64 contents.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Copy document

Copy document.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.
- Name (`name`, text, required): Name.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}
```

### Create document

Create document.

**Inputs**

- Name (`name`, text, required): Name.
- Type (`type`, text, required): Type. One of: `html`, `pdf`, `docx`, `xlsx`, `pptx`.
- Output (`output`, text, required): Output. One of: `pdf`, `docx`, `xlsx`, `pptx`, `email`.
- Html (`html`, text): Html.
- File url (`file_url`, text): File url.
- File contents (`file_contents`, text): File contents.
- Output name (`output_name`, text): Output name.
- Folder (`folder`, text): Folder.
- Size width (`size_width`, number): Size width. At least 0.
- Size height (`size_height`, number): Size height. At least 0.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}
```

### Create route

Create route.

**Inputs**

- Name (`name`, text, required): Name.
- Rules (`rules`, list, required): Rules.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}
```

### Delete document

Delete document.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": 1
  }
}
```

### Delete route

Delete route.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": 1
  }
}
```

### Download template

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

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.

**Outputs**

- `data` (object): The uploaded template file.

**Example output**

```json
{
  "data": {
    "contents": "example",
    "last_update": "example",
    "type": "example"
  }
}
```

### Encrypt pdf

Encrypt pdf.

**Inputs**

- File (`file`, object, required): Name plus either a public URL or base64 contents.
- Password (`password`, text, required): Password.
- User password (`user_password`, text): User password.
- Permissions (`permissions`, list): Permissions. One or more of: `Printing`, `DegradedPrinting`, `ModifyContents`, `Assembly`, `CopyContents`, `FillIn`, `AllFeatures`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Get document

Get document.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}
```

### Get route

Get route.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}
```

### List document deliveries

List document deliveries.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List document fields

List document fields.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List documents

List documents.

**Inputs**

- Search (`search`, text): Search.
- Folder (`folder`, text): Folder.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List route deliveries

List route deliveries.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List route fields

List route fields.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List route rules

List route rules.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### List routes

List routes.

**Inputs**: None.

**Outputs**

- `data` (list): Returned value.

**Example output**

```json
{
  "data": []
}
```

### Merge document

Merge document.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.
- Data (`data`, object, required): Data.
- Test (`test`, true/false): Test.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": 1
  }
}
```

### Merge route

Merge route.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.
- Data (`data`, object, required): Data.
- Test (`test`, true/false): Test.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "success": 1
  }
}
```

### Split pdf

Split pdf.

**Inputs**

- File (`file`, object, required): Name plus either a public URL or base64 contents.
- Extract (`extract`, text): Page ranges to extract, for example 1-3,5.
- Remove (`remove`, text): Page ranges to remove.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}
```

### Update document

Update document.

**Inputs**

- Document (`document_id`, text, required): Choose a document or use its ID.
- Name (`name`, text): Name.
- Output (`output`, text): Output. One of: `pdf`, `docx`, `xlsx`, `pptx`, `email`.
- Html (`html`, text): Html.
- File url (`file_url`, text): File url.
- File contents (`file_contents`, text): File contents.
- Output name (`output_name`, text): Output name.
- Folder (`folder`, text): Folder.
- Size width (`size_width`, number): Size width. At least 0.
- Size height (`size_height`, number): Size height. At least 0.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "fields": [],
    "html": "example",
    "id": "example",
    "key": "example",
    "name": "example",
    "output": "example",
    "type": "example",
    "url": "example"
  }
}
```

### Update route

Update route.

**Inputs**

- Route (`route_id`, text, required): Choose a data route or use its ID.
- Name (`name`, text): Name.
- Rules (`rules`, list): Rules.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example",
    "key": "example",
    "name": "example",
    "url": "example"
  }
}
```
