# Formstack

> Manage forms, fields, submissions and folders with the current Formstack API.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/formstack

## Actions

### Copy form

Create a copy of an existing form with optional configurations.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Include integrations (`include_integrations`, true/false): Flag to specify whether to copy integrations. Default: `true`.
- Include emails (`include_emails`, true/false): Flag to specify whether to copy emails. Default: `true`.
- Template (`template`, number): Id of template to use when copying
- Folder (`folder`, number): Id of folder where copy should be saved

**Outputs**

- `data` (object): Form details response

**Example output**

```json
{
  "data": {
    "canEdit": false,
    "created": "example",
    "fields": [],
    "folder": 1,
    "formExtras": {
      "fieldLabelsPosition": "example",
      "language": "example",
      "numberOfColumns": 1,
      "showProgressIndicator": false,
      "skipValidationBetweenPages": false,
      "useCaptcha": false,
      "useFieldPrefill": false,
      "useOneQuestionAtATime": false,
      "usePromptForLocation": false,
      "useSaveAndResume": false,
      "useSecurityLogo": false
    },
    "formSettings": {
      "alias": "example",
      "isActive": false,
      "saveSubmissionsToDatabase": false,
      "timezone": "example"
    },
    "hasApprovers": false,
    "id": 1,
    "isEncrypted": false,
    "isWorkflowForm": false,
    "isWorkflowPublished": false,
    "name": "example",
    "permissions": 1,
    "submissionsCount": 1,
    "submitButtonTitle": "example",
    "todaySubmissionsCount": 1,
    "unreadSubmissionsCount": 1,
    "updated": "example",
    "url": "example",
    "version": 1,
    "viewKey": "example"
  }
}
```

### Count submissions

Counting form submissions.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Start date (`start_date`, date and time): When to start submission count from.
- Lookback period (`lookback_period`, number): How many days to count backwards from (maximum is 7 days).

**Outputs**

- `data` (object): Form submission count response

**Example output**

```json
{
  "data": {
    "totalSubmissions": 1,
    "totalSubmissionsByDay": []
  }
}
```

### Create field

Create a new field within the specified form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Label (`label`, text, required): Label of the field
- Type (`type`, text, required): Type of the field. One of: `text`, `textarea`, `checkbox`, `radio`, `select`, `number`, `name`, `email`, `phone`, `address`, and 11 more.
- Internal label (`internal_label`, text): Internal label of the field
- Supporting text (`supporting_text`, text): Description of the field
- Use callout (`use_callout`, true/false): Flag to show the description in a callout box. Default: `false`.
- Required (`required`, true/false): Flag to mark field as required. Default: `false`.
- Read only (`read_only`, true/false): Flag to not allow the field to be changed. Default: `false`.
- Hidden (`hidden`, true/false): Flag to hide the field. Default: `false`.
- Unique (`unique`, true/false): Flag to mark field as requiring a unique value. Default: `false`.
- Hide label (`hide_label`, true/false): Flag to show or hide the label. Default: `false`.
- Column span (`column_span`, number): Determines how many columns this field takes on the live form. Default: `1`.
- Language (`language`, text): Language of the field. One of: `default`, `af`, `sq`, `ar`, `bg`, `zh`, `zh-TW`, `hr`, `cs`, `da`, and 27 more. Default: `default`.
- Default value (`default_value`, text): Default value of the field on the live form
- Options (`options`, list): Options attached to field
- Smart list id (`smart_list_id`, number): ID of smart list to attach
- Unlink smart list (`unlink_smart_list`, true/false): Flag to unlink smart list from field
- Attributes (`attributes`, object): Field attributes component
- Logic (`logic`, object): Field logic conditions for conditional processing
- Numeric calculation (`numeric_calculation`, object): Numeric calculation definition for this field
- Datetime calculation (`datetime_calculation`, object): Datetime calculation definition for this field

**Outputs**

- `data` (object): Field details

**Example output**

```json
{
  "data": {
    "attributes": {
      "confirmationText": "example",
      "hideInputCharacters": false,
      "maxLength": 1,
      "minLength": 1,
      "placeholder": "example",
      "removeDataFromEmailsAndExports": false,
      "requireConfirmation": false,
      "restrictDataAccess": false
    },
    "columnSpan": 1,
    "datetimeCalculations": {
      "calculationAllowNegatives": false,
      "calculationOperator": "+",
      "calculationType": "date",
      "calculationUnits": "days",
      "fieldOneCalculation": "example",
      "fieldTwoCalculation": "example"
    },
    "defaultValue": "example",
    "displayOrder": 1,
    "hidden": false,
    "hideLabel": false,
    "id": 1,
    "internalLabel": "example",
    "label": "example",
    "labelKey": "example",
    "language": "example",
    "logic": {
      "action": "example",
      "fields": [],
      "operator": "example"
    },
    "numericCalculations": [],
    "options": [],
    "readOnly": false,
    "required": false,
    "smartListId": 1,
    "supportingText": "example",
    "type": "example",
    "unique": false,
    "useCallout": false
  }
}
```

### Create form

Create a new form with optional fields.

**Inputs**

- Name (`name`, text, required): Name of the form
- Template (`template`, number): ID of template of the form
- Stock template (`stock_template`, text): Stock theme template code for the form. One of: `berryNice`, `blueAfterglow`, `calmZigZag`, `celadonParchment`, `clean`, `confetti`, `corporateOffice`, `dark`, `duskPop`, `formstack`, and 7 more. Default: `light`.
- Folder (`folder`, number): ID of the folder where the form will be created
- Submit button title (`submit_button_title`, text): Title of submit button on live form. Default: `Submit Form`.
- Number of columns (`number_of_columns`, number): Number of visible columns in the form. Default: `1`.
- Field labels position (`field_labels_position`, text): Position where field labels are placed on the live form. One of: `top`, `left`. Default: `top`.
- Save submissions to database (`save_submissions_to_database`, true/false): Flag to disable or enable submissions to be saved in our database. Default: `true`.
- Timezone (`timezone`, text): Timezone of the form. One of: `Pacific/Kwajalein`, `Pacific/Midway`, `Pacific/Honolulu`, `America/Anchorage`, `US/Pacific`, `US/Arizona`, `US/Mountain`, `US/Central`, `America/Mexico_City` (America/mexico city), `Canada/Saskatchewan`, and 42 more. Default: `US/Eastern`.
- Language (`language`, text): Language of the form. One of: `af`, `sq`, `ar`, `bg`, `zh`, `zh-TW`, `hr`, `cs`, `da`, `nl`, and 26 more. Default: `en`.
- Is active (`is_active`, true/false): Flag to make the form active/inactive. Default: `true`.
- Disabled message (`disabled_message`, text): The message to show when the form is inactive
- Fields (`fields`, list): Optional fields to create with the form

**Outputs**

- `data` (object): Form details response

**Example output**

```json
{
  "data": {
    "canEdit": false,
    "created": "example",
    "fields": [],
    "folder": 1,
    "formExtras": {
      "fieldLabelsPosition": "example",
      "language": "example",
      "numberOfColumns": 1,
      "showProgressIndicator": false,
      "skipValidationBetweenPages": false,
      "useCaptcha": false,
      "useFieldPrefill": false,
      "useOneQuestionAtATime": false,
      "usePromptForLocation": false,
      "useSaveAndResume": false,
      "useSecurityLogo": false
    },
    "formSettings": {
      "alias": "example",
      "isActive": false,
      "saveSubmissionsToDatabase": false,
      "timezone": "example"
    },
    "hasApprovers": false,
    "id": 1,
    "isEncrypted": false,
    "isWorkflowForm": false,
    "isWorkflowPublished": false,
    "name": "example",
    "permissions": 1,
    "submissionsCount": 1,
    "submitButtonTitle": "example",
    "todaySubmissionsCount": 1,
    "unreadSubmissionsCount": 1,
    "updated": "example",
    "url": "example",
    "version": 1,
    "viewKey": "example"
  }
}
```

### Create submission

Create a new submission for the specified form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Fields (`fields`, list): Array of field data to be submitted with their values
- User agent (`user_agent`, text): The browser user agent string of the submitter
- Remote addr (`remote_addr`, text): The IP address from which the submission is being made
- Read (`read`, text): Whether to mark the submission as read upon creation (true/false)
- Longitude (`longitude`, text): The GPS longitude coordinate if location data is available
- Latitude (`latitude`, text): The GPS latitude coordinate if location data is available
- Device id (`device_id`, text): The unique device identifier if available from mobile submissions
- Field values (`field_values`, object): Fill in the form fields. Text values are converted to Formstack values automatically.

**Outputs**

- `data` (object): Response containing details of a newly created submission

**Example output**

```json
{
  "data": {
    "data": [],
    "formId": 1,
    "id": 1,
    "latitude": "example",
    "longitude": "example",
    "paymentStatus": "example",
    "remoteAddr": "example",
    "timestamp": "example",
    "userAgent": "example"
  }
}
```

### Delete field

Permanently delete a field from the specified form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Field id (`field_id`, number, required): Field id.

**Outputs**

- `data` (object): Field preview response

**Example output**

```json
{
  "data": {
    "attributes": {
      "confirmationText": "example",
      "hideInputCharacters": false,
      "maxLength": 1,
      "minLength": 1,
      "placeholder": "example",
      "removeDataFromEmailsAndExports": false,
      "requireConfirmation": false,
      "restrictDataAccess": false
    },
    "columnSpan": 1,
    "datetimeCalculations": {
      "calculationAllowNegatives": false,
      "calculationOperator": "+",
      "calculationType": "date",
      "calculationUnits": "days",
      "fieldOneCalculation": "example",
      "fieldTwoCalculation": "example"
    },
    "defaultValue": "example",
    "displayOrder": 1,
    "hidden": false,
    "hideLabel": false,
    "id": 1,
    "internalLabel": "example",
    "label": "example",
    "labelKey": "example",
    "language": "example",
    "logic": {
      "action": "example",
      "fields": [],
      "operator": "example"
    },
    "numericCalculations": [],
    "options": [],
    "readOnly": false,
    "required": false,
    "smartListId": 1,
    "supportingText": "example",
    "type": "example",
    "unique": false,
    "useCallout": false
  }
}
```

### Delete form

Soft delete a form (mark as deleted).

**Inputs**

- Form (`form_id`, number, required): Form id.

**Outputs**

- `data` (object): Form preview response

**Example output**

```json
{
  "data": {
    "active": false,
    "created": "example",
    "dataUrl": "example",
    "db": false,
    "deleted": false,
    "editUrl": "example",
    "encrypted": false,
    "folder": 1,
    "id": 1,
    "inactive": false,
    "isWorkflowForm": false,
    "isWorkflowPublished": false,
    "language": "example",
    "name": "example",
    "numberOfColumns": "example",
    "progressMeter": "example",
    "shouldDisplayOneQuestionAtATime": false,
    "submissions": "example",
    "submissionsCount": 1,
    "submissionsUnread": "example",
    "submitButtonTitle": "example",
    "summaryUrl": "example",
    "thumbnailUrl": "example",
    "timezone": "example",
    "unreadSubmissionsCount": 1,
    "updated": "example",
    "url": "example",
    "version": "example",
    "viewKey": "example",
    "views": "example"
  }
}
```

### Delete submission

Permanently delete a submission and all associated data.

**Inputs**

- Submission id (`submission_id`, number, required): Submission id.

**Outputs**

- `data` (object): Submission delete response

**Example output**

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

### Get field

Retrieve detailed information about a specific field.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Field id (`field_id`, number, required): Field id.

**Outputs**

- `data` (object): Field details

**Example output**

```json
{
  "data": {
    "attributes": {
      "confirmationText": "example",
      "hideInputCharacters": false,
      "maxLength": 1,
      "minLength": 1,
      "placeholder": "example",
      "removeDataFromEmailsAndExports": false,
      "requireConfirmation": false,
      "restrictDataAccess": false
    },
    "columnSpan": 1,
    "datetimeCalculations": {
      "calculationAllowNegatives": false,
      "calculationOperator": "+",
      "calculationType": "date",
      "calculationUnits": "days",
      "fieldOneCalculation": "example",
      "fieldTwoCalculation": "example"
    },
    "defaultValue": "example",
    "displayOrder": 1,
    "hidden": false,
    "hideLabel": false,
    "id": 1,
    "internalLabel": "example",
    "label": "example",
    "labelKey": "example",
    "language": "example",
    "logic": {
      "action": "example",
      "fields": [],
      "operator": "example"
    },
    "numericCalculations": [],
    "options": [],
    "readOnly": false,
    "required": false,
    "smartListId": 1,
    "supportingText": "example",
    "type": "example",
    "unique": false,
    "useCallout": false
  }
}
```

### Get form

Retrieve detailed information about a specific form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- With fields (`with_fields`, true/false): Include form fields in response. Default: `false`.

**Outputs**

- `data` (object): Form details response

**Example output**

```json
{
  "data": {
    "canEdit": false,
    "created": "example",
    "fields": [],
    "folder": 1,
    "formExtras": {
      "fieldLabelsPosition": "example",
      "language": "example",
      "numberOfColumns": 1,
      "showProgressIndicator": false,
      "skipValidationBetweenPages": false,
      "useCaptcha": false,
      "useFieldPrefill": false,
      "useOneQuestionAtATime": false,
      "usePromptForLocation": false,
      "useSaveAndResume": false,
      "useSecurityLogo": false
    },
    "formSettings": {
      "alias": "example",
      "isActive": false,
      "saveSubmissionsToDatabase": false,
      "timezone": "example"
    },
    "hasApprovers": false,
    "id": 1,
    "isEncrypted": false,
    "isWorkflowForm": false,
    "isWorkflowPublished": false,
    "name": "example",
    "permissions": 1,
    "submissionsCount": 1,
    "submitButtonTitle": "example",
    "todaySubmissionsCount": 1,
    "unreadSubmissionsCount": 1,
    "updated": "example",
    "url": "example",
    "version": 1,
    "viewKey": "example"
  }
}
```

### Get form html

Retrieve HTML markup for a specific form.

**Inputs**

- Form (`form_id`, number, required): Form id.

**Outputs**

- `data` (object): Form HTML response

**Example output**

```json
{
  "data": {
    "html": "example",
    "id": 1,
    "name": "example"
  }
}
```

### Get submission

Retrieve detailed information about a specific submission.

**Inputs**

- Submission id (`submission_id`, number, required): Submission id.
- X- f s- encryption- password (`x__f_s__encryption__password`, text): X f s encryption password.

**Outputs**

- `data` (object): Comprehensive response containing all details of a submission

**Example output**

```json
{
  "data": {
    "approvalStatus": "example",
    "data": [],
    "formId": 1,
    "id": 1,
    "latitude": "example",
    "longitude": "example",
    "paymentStatus": "example",
    "portal": [],
    "prettyFieldId": 1,
    "remoteAddr": "example",
    "timestamp": "example",
    "userAgent": "example",
    "workflow": []
  }
}
```

### List fields

Retrieve all fields from a form.

**Inputs**

- Form (`form_id`, number, required): Form id.

**Outputs**

- `data` (object): Field listing response

**Example output**

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

### List folders

Get all folders on your account and their subfolders.

**Inputs**

- Page (`page`, number): Page.
- Per page (`per_page`, number): Per page.

**Outputs**

- `data` (object): Folders listing response

**Example output**

```json
{
  "data": {
    "folders": [],
    "page": {
      "pageNumber": 1,
      "pageSize": 1,
      "size": 1,
      "totalElements": 1,
      "totalPages": 1
    }
  }
}
```

### List form submissions

Retrieve a paginated list of submissions for a specific form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Page number (`page_number`, number): Page to use when paginating through items. At least 1.
- Page size (`page_size`, number): Number of items to return per page. From 10 to 500. Default: `50`.
- Order (`order`, text): Order direction of results. One of: `ASC`, `DESC`. Default: `ASC`.
- Keyword (`keyword`, text): Keyword to search.
- Min time (`min_time`, date and time): Return submissions at and after given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).
- Max time (`max_time`, date and time): Return submissions at and before given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).
- Search (`search`, list): Array of search criteria to filter submissions by specific field values. Each criterion must include a fieldId and value. Maximum 10 search criteria allowed (index 0-9).
- Data (`data`, text): Flag to include submission data.
- Expand data (`expand_data`, text): Flag to expand submission data.
- Pretty name (`pretty_name`, text): Flag to include pretty name.
- Data format (`data_format`, text): Shape of the 'data' field when data=true. 'legacy' (default): map keyed by field id with value/flat_value/internal_label. 'standardized': array of field objects matching GET /submissions/{id} with displayValue/parsedValue/internalLabel. One of: `legacy`, `standardized`. Default: `legacy`.
- X- f s- encryption- password (`x__f_s__encryption__password`, text): X f s encryption password.

**Outputs**

- `data` (object): Form submissions listing response

**Example output**

```json
{
  "data": {
    "page": {
      "pageNumber": 1,
      "pageSize": 1,
      "size": 1,
      "totalElements": 1,
      "totalPages": 1
    },
    "submissions": []
  }
}
```

### List forms

Retrieve a paginated list of forms with optional filtering and sorting.

**Inputs**

- Page number (`page_number`, number): Page to use when paginating through items. At least 1.
- Page size (`page_size`, number): Number of items to return per page. From 10 to 500. Default: `50`.
- Search (`search`, text): Search by form name
- Order by (`order_by`, text): Column to order results.
- Order (`order`, text): Order direction of results. One of: `ASC`, `DESC`. Default: `ASC`.
- Folder (`folder`, number): Forms from specified folder.

**Outputs**

- `data` (object): Forms listing response

**Example output**

```json
{
  "data": {
    "forms": [],
    "page": {
      "pageNumber": 1,
      "pageSize": 1,
      "size": 1,
      "totalElements": 1,
      "totalPages": 1
    }
  }
}
```

### Prefill form

Generate a prefilled form URL with specified field values.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Incomplete password (`incomplete_password`, text): Password for prefill
- Workflow step key (`workflow_step_key`, text): Internal use only. Used by Workflows (Copilot) to link form submissions back to workflow steps. Not applicable for standard API usage.
- Fields (`fields`, list): Array of field data to prefill with their values
- Field values (`field_values`, object): Fill in the form fields. Text values are converted to Formstack values automatically.

**Outputs**

- `data` (object): Prefill response

**Example output**

```json
{
  "data": {
    "prefilledUrl": "example"
  }
}
```

### Update field

Update an existing field within the specified form.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Field id (`field_id`, number, required): Field id.
- Label (`label`, text): Label of the field
- Type (`type`, text): Type of the field. One of: `text`, `textarea`, `checkbox`, `radio`, `select`, `number`, `name`, `email`, `phone`, `address`, and 12 more.
- Internal label (`internal_label`, text): Internal label of the field
- Supporting text (`supporting_text`, text): Description of the field
- Use callout (`use_callout`, true/false): Flag to show the description in a callout box. Default: `false`.
- Required (`required`, true/false): Flag to mark field as required. Default: `false`.
- Read only (`read_only`, true/false): Flag to not allow the field to be changed. Default: `false`.
- Hidden (`hidden`, true/false): Flag to hide the field. Default: `false`.
- Unique (`unique`, true/false): Flag to mark field as requiring a unique value. Default: `false`.
- Hide label (`hide_label`, true/false): Flag to show or hide the label. Default: `false`.
- Column span (`column_span`, number): Determines how many columns this field takes on the live form. Default: `1`.
- Language (`language`, text): Language of the field. One of: `default`, `af`, `sq`, `ar`, `bg`, `zh`, `zh-TW`, `hr`, `cs`, `da`, and 27 more. Default: `default`.
- Default value (`default_value`, text): Default value of the field on the live form
- Options (`options`, list): Options attached to field
- Smart list id (`smart_list_id`, number): ID of smart list to attach
- Unlink smart list (`unlink_smart_list`, true/false): Flag to unlink smart list from field
- Attributes (`attributes`, object): Field attributes component
- Logic (`logic`, object): Field logic conditions for conditional processing
- Numeric calculation (`numeric_calculation`, object): Numeric calculation definition for this field
- Datetime calculation (`datetime_calculation`, object): Datetime calculation definition for this field

**Outputs**

- `data` (object): Field details

**Example output**

```json
{
  "data": {
    "attributes": {
      "confirmationText": "example",
      "hideInputCharacters": false,
      "maxLength": 1,
      "minLength": 1,
      "placeholder": "example",
      "removeDataFromEmailsAndExports": false,
      "requireConfirmation": false,
      "restrictDataAccess": false
    },
    "columnSpan": 1,
    "datetimeCalculations": {
      "calculationAllowNegatives": false,
      "calculationOperator": "+",
      "calculationType": "date",
      "calculationUnits": "days",
      "fieldOneCalculation": "example",
      "fieldTwoCalculation": "example"
    },
    "defaultValue": "example",
    "displayOrder": 1,
    "hidden": false,
    "hideLabel": false,
    "id": 1,
    "internalLabel": "example",
    "label": "example",
    "labelKey": "example",
    "language": "example",
    "logic": {
      "action": "example",
      "fields": [],
      "operator": "example"
    },
    "numericCalculations": [],
    "options": [],
    "readOnly": false,
    "required": false,
    "smartListId": 1,
    "supportingText": "example",
    "type": "example",
    "unique": false,
    "useCallout": false
  }
}
```

### Update form

Update an existing form's properties.

**Inputs**

- Form (`form_id`, number, required): Form id.
- Name (`name`, text): Name of the form
- Template (`template`, number): ID of template of the form
- Stock template (`stock_template`, text): Stock theme template code for the form. One of: `berryNice`, `blueAfterglow`, `calmZigZag`, `celadonParchment`, `clean`, `confetti`, `corporateOffice`, `dark`, `duskPop`, `formstack`, and 7 more. Default: `light`.
- Folder (`folder`, number): ID of the folder where the form will be moved
- Submit button title (`submit_button_title`, text): Title of submit button on live form
- Number of columns (`number_of_columns`, number): Number of visible columns in the form
- Field labels position (`field_labels_position`, text): Position where field labels are placed on the live form. One of: `top`, `left`.
- Save submissions to database (`save_submissions_to_database`, true/false): Flag to disable or enable submissions to be saved in our database
- Timezone (`timezone`, text): Timezone of the form. One of: `Pacific/Kwajalein`, `Pacific/Midway`, `Pacific/Honolulu`, `America/Anchorage`, `US/Pacific`, `US/Arizona`, `US/Mountain`, `US/Central`, `America/Mexico_City` (America/mexico city), `Canada/Saskatchewan`, and 42 more.
- Language (`language`, text): Language of the form. One of: `af`, `sq`, `ar`, `bg`, `zh`, `zh-TW`, `hr`, `cs`, `da`, `nl`, and 26 more.
- Is active (`is_active`, true/false): Flag to make the form active/inactive
- Disabled message (`disabled_message`, text): The message to show when the form is inactive

**Outputs**

- `data` (object): Form details response

**Example output**

```json
{
  "data": {
    "canEdit": false,
    "created": "example",
    "fields": [],
    "folder": 1,
    "formExtras": {
      "fieldLabelsPosition": "example",
      "language": "example",
      "numberOfColumns": 1,
      "showProgressIndicator": false,
      "skipValidationBetweenPages": false,
      "useCaptcha": false,
      "useFieldPrefill": false,
      "useOneQuestionAtATime": false,
      "usePromptForLocation": false,
      "useSaveAndResume": false,
      "useSecurityLogo": false
    },
    "formSettings": {
      "alias": "example",
      "isActive": false,
      "saveSubmissionsToDatabase": false,
      "timezone": "example"
    },
    "hasApprovers": false,
    "id": 1,
    "isEncrypted": false,
    "isWorkflowForm": false,
    "isWorkflowPublished": false,
    "name": "example",
    "permissions": 1,
    "submissionsCount": 1,
    "submitButtonTitle": "example",
    "todaySubmissionsCount": 1,
    "unreadSubmissionsCount": 1,
    "updated": "example",
    "url": "example",
    "version": 1,
    "viewKey": "example"
  }
}
```

### Update submission

Update an existing submission with new data.

**Inputs**

- Submission id (`submission_id`, number, required): Submission id.
- X- f s- encryption- password (`x__f_s__encryption__password`, text): X f s encryption password.
- Fields (`fields`, list): Fields of the submission
- User agent (`user_agent`, text): User agent of the submission
- Remote addr (`remote_addr`, text): Remote addr of the submission
- Payment status (`payment_status`, text): Payment status of the submission
- Read (`read`, text): Flag to mark the submission as read
- Timestamp (`timestamp`, text): Timestamp of the submission
- Field values (`field_values`, object): Fill in the form fields. Text values are converted to Formstack values automatically.

**Outputs**

- `data` (object): Submission edit response

**Example output**

```json
{
  "data": {
    "formId": 1,
    "id": 1,
    "paymentStatus": "example",
    "read": "example",
    "remoteAddr": "example",
    "timestamp": "example",
    "userAgent": "example"
  }
}
```
