---
title: "Update a form"
method: PATCH
path: "/v1/forms/{id}/"
tags: ["Forms"]
---

# Update a form

`PATCH /v1/forms/{id}/`

## Request

- Base URL: `https://api.pdfbetter.com`
- URL: `https://api.pdfbetter.com/v1/forms/{id}/`
- Auth: HTTP bearer

Pause, close or reopen it (`status`), or change its title/description. Reopening checks your plan's live-form allowance.

## Path parameters

- `id` string, required

## Request body

- object
  - `status` 'live' | 'paused' | 'closed'
  - `title` string
  - `description` string, nullable

## Response `200`

Update a form

- Form
  - `object` 'form', required
  - `id` string, required
  - `documentId` string, required
  - `title` string, required
  - `description` string, nullable, required
  - `status` 'live' | 'paused' | 'closed', required
  - `edition` integer, required
  - `responseCount` integer, required
  - `fieldCount` integer, required
  - `url` string, required
  - `createdAt` string, required: ISO 8601 timestamp (UTC)
  - `updatedAt` string, required: ISO 8601 timestamp (UTC)

## Other responses

- `400`: Invalid request (see `error.details.issues`)
- `401`: Missing or invalid API key
- `402`: Your plan doesn't include this (API access needs Business) or a monthly allowance is used up
- `403`: The API key lacks the required scope
- `404`: Not found (or not yours)
- `409`: Conflict with the current state
- `422`: Validation failed
- `429`: Rate limited — see RateLimit-* and Retry-After

---

[API](https://skmtc.dev/pdfbetter/apis/pdfbetter-api.md) · [All operations](https://skmtc.dev/pdfbetter/apis/pdfbetter-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pdfbetter/apis/pdfbetter-api/revisions/6960b18754a8?raw)