Forms / Create
Creates new form..
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/forms
Method: POST
Authorisation: Minimum role: ADMIN
Request Arguments
Response object
Response status: 200 (OK)
Response type:
DTO_form
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Name Type ReadOnly Description
group_access DTO_group_access []Group access sys_tags DTO_reference []Label can be used on POST/PUT to create new tags collect_to_list DTO_reference Collect to list collect_to_group DTO_reference Collect to group modules DTO_form_module []Modules logics DTO_form_logic []Logics language DTO_reference Language created_by DTO_reference_user ReadOnly Created by last_updated_by DTO_reference_user ReadOnly Last updated by id Int32 ReadOnly Leave empty on input highest_group_permission ENUM group_permission ReadOnly Highest group permission name String Name unique_key String Unique key privacy ENUM privacy Privacy collect_type ENUM form_collect_type Collect type display_type ENUM form_display_type Display type submit_text String Submit text ticket_subject String Ticket subject primary_color String Primary color background_color String Background color ai_chat_bot_enabled Boolean (nullable) When true, the embedded form starts as an AI chat-bot answering from approved public FAQs.
Enabling requires at least 100 approved FAQ items.
Nullable so clients that omit the property on update leave the stored value unchanged. created DateTime ReadOnly Created last_updated DateTime ReadOnly Last updated
DTO_group_access
Name Type ReadOnly Description
permission ENUM group_permission Permission id Int32 Id label Object ReadOnly Label
DTO_reference
Name Type ReadOnly Description
id Int32 The id of the reference label Object ReadOnly Name/Label from referenced object.
Name Type ReadOnly Description
module_field DTO_form_module_field Module field type ENUM form_module_type Type text_primary String Text primary text_secondary String Text secondary enabled Boolean Enabled
Name Type ReadOnly Description
id Int32 Id label String Label required Boolean Required
DTO_reference_user
Name Type ReadOnly Description
profile_pic String ReadOnly Profile pic email String ReadOnly Email id Int32 Id label Object ReadOnly Label
ENUM group_permission
Value Name Description
0 UNKNOWN UNKNOWN 1 READ Read only 2 EDIT Edit 3 FULL Full
Value Name Description
0 UNKNOWN UNKNOWN 1 HEADER HEADER 2 INFORMATION INFORMATION 3 FIELD FIELD 4 LINE_SEPARATOR LINE_SEPARATOR 5 PAGE_SEPARATOR PAGE_SEPARATOR 6 SUBMIT_MESSAGE SUBMIT_MESSAGE
Value Name Description
0 UNKNOWN UNKNOWN 1 AND AND 2 OR OR
ENUM privacy
Value Name Description
0 UNKNOWN UNKNOWN 1 PRIVATE PRIVATE 2 PUBLIC PUBLIC
Value Name Description
0 UNKNOWN UNKNOWN 1 TICKET TICKET 2 LIST LIST
Value Name Description
0 UNKNOWN UNKNOWN 1 CLASSIC CLASSIC 2 CARD CARD
