Skip to main content
PATCH
Update Form
Update a form’s status or properties.

Updatable Fields

Common Use Cases

Archive a Form

Archive completed or cancelled forms to keep your list organized:

Mark as Processed

Track which forms you’ve reviewed in your system:

Activate a Draft

Activate a draft form to send it to the contact:

Response Codes

You can only update certain fields. To modify form data or user information, you’ll need to create a new form.

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Path Parameters

id
string<uuid>
required

Form UUID

Body

application/json

At least one field must be provided

archived
boolean

Archive or unarchive the form

draft
boolean

Set draft status

processed
boolean

Mark as processed or unprocessed

active_until
string<date-time>

Update expiration date (ISO 8601)

Response

200 - application/json

Form updated successfully

id
string<uuid>

Form UUID

created_at
string<date-time>

Creation timestamp

status
enum<string>

Current form status

Available options:
draft,
pending,
completed,
declined,
processed
archived
boolean

Whether the form is archived

archived_at
string<date-time> | null

Timestamp when archived

processed_at
string<date-time> | null

Timestamp when marked as processed

active_from
string<date-time> | null

When the form becomes active

active_until
string<date-time> | null

When the form expires

URLs for accessing the form

user
object

Contact information

owner
object | null

Form owner information

flow
object

Form template information

data
object

Pre-filled form data

external_args
object | null

Custom metadata

options
object | null

Form-specific options

responses
object[]

Array of form responses

notifications
object[]

Array of notifications sent for this form

webhooks
object | null

Webhook URLs with event subscriptions