Forms

Update a form

Updates a form.

put/api/forms/{formId}

Path parameters

formIdinteger required

The ID of the form.

Request body

namestring required

The name of the form.

descriptionstring nullable

The description of the form.

isEnabledboolean required

Indicates if the form is enabled.

webHookSettingsJsonstring nullable

The JSON data containing webhook configuration settings for this form.

Response

Form updated successfully.

idstring nullable

The ID of the form.

namestring nullable

The name of the form.

descriptionstring nullable

The description of the form.

isEnabledboolean

Indicates if the form is enabled.

themeIdstring nullable

The ID of the theme associated with the form.

createdAtstring date-time

The date and time when the form was created.

modifiedAtstring date-time nullable

The date and time when the form was last modified.

submissionsCountinteger nullable

The total number of submissions for the form

webHookSettingsJsonstring nullable

The JSON data containing webhook configuration settings for this form as a string.

{"stackTrail":"components:schemas:UpdateFormResponse:allOf:properties:webHookSettings","oasType":"schema","type":"unknown","description":"The webhook configuration settings as a JSON object.","nullable":true}

Changes

Changed in 2 of the 7 revisions of this API.145

Nov 21, 202550eff5014b7814See the full diff
- ▲
  removed the media type application/problem+json for the response with the status 400
  response-media-type-removed
- ○
  added the new optional request property webHookSettingsJson
  new-optional-request-property
- ○
  added the optional property allOf[FormModel]/themeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[FormModel]/webHookSettings to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[FormModel]/webHookSettingsJson to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 24, 2025fbc3fe6ecbf141See the full diff
- ●
  removed the request property webHookSettingsJson
  request-property-removed
- ●
  removed the optional property allOf[FormModel]/themeId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[FormModel]/webHookSettings from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property allOf[FormModel]/webHookSettingsJson from the response with the 200 status
  response-optional-property-removed
- ○
  added the media type application/problem+json for the response with the status 400
  response-media-type-added
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history