Skip to main content
PATCH
/
forms
/
{id}
Update Form
curl --request PATCH \
  --url https://geniusforms.ai/api/v1/forms/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "webhookUrl": "<string>",
  "webhookEnabled": true
}
'
{
  "id": 208,
  "title": "Customer Feedback",
  "description": "Help us improve our service",
  "isPublished": false,
  "shareUrl": "abc123xyz",
  "url": "https://geniusforms.ai/f/abc123xyz",
  "displayMode": "single-page",
  "createdAt": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "webhook": {
    "enabled": false,
    "url": "https://example.com/webhook"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key obtained from your GeniusForms dashboard

Path Parameters

​
id
integer
required

Body

application/json
​
title
string
​
description
string
​
displayMode
enum<string>
Available options:
single-page,
multi-step
​
webhookUrl
string | null

Webhook URL to receive form submissions. Set to null or empty string to clear.

Maximum string length: 2000
​
webhookEnabled
boolean

Enable or disable webhook delivery. Requires a webhookUrl to be set.

Response

200 - application/json

Form updated

​
id
integer
Example:

208

​
title
string
Example:

"Customer Feedback"

​
description
string
Example:

"Help us improve our service"

​
isPublished
boolean
Example:

false

​
shareUrl
string
Example:

"abc123xyz"

​
url
string
Example:

"https://geniusforms.ai/f/abc123xyz"

​
displayMode
enum<string>
Available options:
single-page,
multi-step
Example:

"single-page"

​
createdAt
string<date-time>
​
publishedAt
string<date-time> | null
​
webhook
object

Webhook configuration for the form