Forms

Create a new form

Creates a new form and an active form definition for it.

post/api/forms

Request body

namestring required

The name of the form.

descriptionstring nullable

The description of the form.

isEnabledboolean required

Indicates if the form is enabled.

formDefinitionJsonDatastring nullable

The JSON data of the active form definition as a string.

{"stackTrail":"components:schemas:CreateFormRequest:properties:formDefinitionSchema","oasType":"schema","type":"unknown","description":"The active form definition schema as a JSON object.","nullable":true}

webHookSettingsJsonstring nullable

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

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

Response

Form created 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:CreateFormResponse: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.3611

Nov 21, 202550eff5014b7819See 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 formDefinitionSchema
  new-optional-request-property
- ○
  added the new optional request property webHookSettings
  new-optional-request-property
- ○
  added the new optional request property webHookSettingsJson
  new-optional-request-property
- ○
  the request property formDefinitionJsonData became nullable
  request-property-became-nullable
- ○
  the request property formDefinitionJsonData became optional
  request-property-became-optional
- ○
  request property formDefinitionJsonData deprecated
  request-property-deprecated
- ○
  added the optional property allOf[FormModel]/themeId to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[FormModel]/webHookSettings to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[FormModel]/webHookSettingsJson to the response with the 201 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, 2025fbc3fe6ecbf1262See the full diff
- ▲
  the request property formDefinitionJsonData became not nullable
  request-property-became-not-nullable
- ▲
  the request property formDefinitionJsonData became required
  request-property-became-required
- ●
  removed the request property formDefinitionSchema
  request-property-removed
- ●
  removed the request property webHookSettings
  request-property-removed
- ●
  removed the request property webHookSettingsJson
  request-property-removed
- ●
  removed the optional property allOf[FormModel]/themeId from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property allOf[FormModel]/webHookSettings from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property allOf[FormModel]/webHookSettingsJson from the response with the 201 status
  response-optional-property-removed
- ○
  request property formDefinitionJsonData reactivated
  request-property-reactivated
- ○
  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