---
title: "Updates a form with given parameters"
method: PATCH
path: "/forms/{id}"
tags: ["Form"]
---

# Updates a form with given parameters

`PATCH /forms/{id}`

Add, update, or delete a form's parameters. This will alter how your users/customers will see and interact with the form when sending you files. 

**Notes**

*This call will **replace** your current form in its entirety.* If you want to keep any existing elements unchanged, be sure to submit the call with an element's current settings to preserve them.

## Headers

- `ev-api-key` string, required
- `ev-access-token` string, required

## Request body

- object — CSS Styles of the form.
  - `formDescription` string — Set a description for the form that will be visible to recipients.
  - `submitButtonText` string — Text to be displayed on the submission button.
  - `successMessage` string — Text to be displayed when a recipient has submitted the form.
  - `elements` object[]
    - `id` integer — ID of the form element. If you're adding a new element to the form, do not include this field.
    - `name` string — Name of the form element.
    - `order` integer — The order the fields will be displayed to the recipient. Starts at 0.
    - `type` 'name' | 'email' | 'text' | 'textarea' | 'upload_area' — Type of form field to use.
    - `settings` object
      - `isRequired` boolean — True is the form element is required for submission.
      - `senderEmail` boolean
      - `useAsFolderName` boolean — True if the submitted response should be used as the name for the new folder.
  - `cssStyles` string

## Response `200`

Successful Operation

- FormResponse — unresolved $ref

---

[API](https://skmtc.net/prismic/apis/exavault-api.md) · [All operations](https://skmtc.net/prismic/apis/exavault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prismic/exavault-api/revisions/a1bd874b5960/schema)