Edit an item
update_itemChange one item on an intake that is already with the client — its type, label, hint, whether it is required, and which file formats it accepts.
Reach for this when the field turns out to be the wrong shape: you asked for an image and the client only has their logo as a PDF, or what you asked for as a line of text is really a file. Widening the accepted formats or switching the type unblocks them without adding a duplicate item and waiving the original.
The item key cannot be changed — results come back under it, so renaming would break whatever reads them. Add a new item instead.
If the client has already answered and the change would make their answer invalid, the call fails and nothing is touched. Repeat it with discard_submitted_value: true to clear the answer and ask them again. A change that leaves their answer valid (a new label, a wider limit) never discards anything.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| help | No | Hint under the label. null clears it. | |
| type | No | ||
| label | No | Human-readable label shown to the client. | |
| options | No | ||
| pattern | No | ||
| item_key | Yes | Key of the item to change. | |
| required | No | ||
| intake_id | Yes | Intake ID returned by define_intake. | |
| constraints | No | Same shape as define_intake, e.g. { "formats": ["svg","png","pdf"] }. null clears all constraints. | |
| discard_submitted_value | No | Go ahead even though it throws away what the client already sent. Only set this after the call has failed once for that reason. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| item | No | ||
| discarded_submitted_value | No |