Skip to main content
PATCH
Update form

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
category
integer
required
form
integer
required

Query Parameters

include
enum<string>
Available options:
fields,
submissions,
submissions.*,
tags

Body

application/json
name
string
required

The name of the form.

Maximum string length: 255
slug
string
required

The unique URL-friendly identifier for the form.

Maximum string length: 255
is_public
boolean
default:false
required

Whether the form is publicly accessible without authentication.

success_message
string | null

The message displayed after successful form submission. Supports HTML.

Maximum string length: 65535
description
string | null

A description of the form. Supports HTML.

Maximum string length: 65535
instructions
string | null

Instructions for completing the form. Supports HTML.

Maximum string length: 65535

Response

OK

data
FormResource · object