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}