---
title: "Update an intake form"
method: PUT
path: "/intake-forms/{id}"
tags: ["intake-forms"]
---

# Update an intake form

`PUT /intake-forms/{id}`

## Request

- Base URL: `https://api.onplana.com/api`
- URL: `https://api.onplana.com/api/intake-forms/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

## Path parameters

- `id` string, required

## Headers

- `X-Organization-Id` string, required

## Request body

- object: Partial update.

## Response `200`

Updated

- IntakeForm
  - `id` string, uuid, required
  - `name` string, required
  - `slug` string, required: Globally-unique URL slug. Public submission URL is `/forms/{slug}`.
  - `description` string, nullable
  - `isPasswordProtected` boolean
  - `targetProjectId` string, uuid, nullable
  - `isPublic` boolean
  - `notifySelf` boolean
  - `notifyUserIds` string[]
  - `notifyTeamIds` string[]
  - `fields` object[], required: Form schema. Each field describes a single input.
    - `label` string, required
    - `type` 'text' | 'textarea' | 'email' | 'number' | 'date' | 'select' | 'multiselect' | 'file', required
    - `required` boolean, required
    - `options` string[]
  - `organizationId` string, uuid, required
  - `createdAt` string, date-time, required

## Other responses

- `400`: Validation error
- `401`: Unauthorized - missing or invalid JWT
- `402`: Plan gate - feature not available on current plan
- `403`: Forbidden - insufficient role
- `404`: Not found

---

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