Skip to main content
PATCH
Update a form definition

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

formDefinitionId
integer | null

Body

application/json
name
string
Minimum string length: 1
type
enum<string>

Form definition type. V1 enables subscription opt-in forms only.

Available options:
subscription_opt_in
Example:

"subscription_opt_in"

status
enum<string>

Lifecycle status for a saved form definition.

Available options:
draft,
active,
archived
Example:

"draft"

settings
object

Response

The updated form definition.

A saved project-scoped form-builder definition. Generated prompt text is derived from settings.

id
integer
required
project_id
integer
required
public_token
string
required
name
string
required
type
enum<string>
required

Form definition type. V1 enables subscription opt-in forms only.

Available options:
subscription_opt_in
Example:

"subscription_opt_in"

status
enum<string>
required

Lifecycle status for a saved form definition.

Available options:
draft,
active,
archived
Example:

"draft"

settings
object
required
created_at
string | null
required
updated_at
string | null
required
deleted_at
string | null