30% OFF on yearly plans. Limited time offer. coupon: WOOHOO

Forms API

The /forms endpoints can be used to get forms and form details.

List all forms

GET /forms

Request parameters

ParameterTypeRequiredDescription
includearraynoAn array of forms by ID to include in the response.

Response

A successful response when not specifying specific forms will contain a JSON object keyed by form ID – each with form details.

{
  "30": {
    "id": "30",
    "title": "API Documentation",
    "entries": "1"
  },
  "31": {
    "id": "31",
    "title": "Inquiry Form",
    "entries": "0"
  },
  "27": {
    "id": "27",
    "title": "Stripe 5.0 Testing",
    "entries": "13"
  }
}

Get a form

GET /forms/{form_id}

Response

{
    "title": "Newsletter Signup Form",
    "description": "",
    "labelPlacement": "top_label",
    "descriptionPlacement": "below",
    "button": {
        "type": "text",
        "text": "Subscribe",
        "imageUrl": "",
        "width": "auto",
        "location": "bottom",
        "layoutGridColumnSpan": 12,
        "id": "submit"
    },
    "fields": [
        {
            "type": "name",
            "id": 1,
            "label": "Name",
            "adminLabel": "",
            "isRequired": true,
            "size": "medium",
            "errorMessage": "",
            "nameFormat": "advanced",
            "inputs": [
                {
                    "id": "1.2",
                    "label": "Prefix",
                    "name": "",
                    "choices": [
                        {
                            "text": "Mr.",
                            "value": "Mr.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Mrs.",
                            "value": "Mrs.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Miss",
                            "value": "Miss",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Ms.",
                            "value": "Ms.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Dr.",
                            "value": "Dr.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Prof.",
                            "value": "Prof.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Rev.",
                            "value": "Rev.",
                            "isSelected": false,
                            "price": ""
                        }
                    ],
                    "isHidden": true,
                    "inputType": "radio"
                },
                {
                    "id": "1.3",
                    "label": "First",
                    "name": "",
                    "placeholder": "First Name",
                    "autocompleteAttribute": "given-name"
                },
                {
                    "id": "1.4",
                    "label": "Middle",
                    "name": "",
                    "isHidden": true
                },
                {
                    "id": "1.6",
                    "label": "Last",
                    "name": "",
                    "placeholder": "Last Name",
                    "autocompleteAttribute": "family-name"
                },
                {
                    "id": "1.8",
                    "label": "Suffix",
                    "name": "",
                    "isHidden": true
                }
            ],
            "formId": 519,
            "description": "",
            "allowsPrepopulate": false,
            "inputMask": false,
            "inputMaskValue": "",
            "inputType": "name",
            "labelPlacement": "hidden_label",
            "descriptionPlacement": "",
            "subLabelPlacement": "hidden_label",
            "placeholder": "",
            "cssClass": "",
            "inputName": "",
            "visibility": "visible",
            "noDuplicates": false,
            "defaultValue": "",
            "choices": "",
            "conditionalLogic": "",
            "productField": "",
            "multipleFiles": false,
            "maxFiles": "",
            "calculationFormula": "",
            "calculationRounding": "",
            "enableCalculation": "",
            "disableQuantity": false,
            "displayAllCategories": false,
            "useRichTextEditor": false,
            "displayOnly": "",
            "pageNumber": 1,
            "fields": "",
            "personalDataExport": "1",
            "personalDataErase": "1",
            "inputMaskIsCustom": false,
            "maxLength": "",
            "layoutGroupId": "abc8be7f",
            "imageChoices_enableImages": false,
            "imageChoices_useLightboxCaption": true,
            "imageChoices_theme": "form_setting",
            "imageChoices_featureColorCustom": "",
            "imageChoices_featureColor": "form_setting",
            "imageChoices_align": "form_setting",
            "imageChoices_imageStyle": "form_setting",
            "imageChoices_height": "",
            "imageChoices_heightMedium": "",
            "imageChoices_heightSmall": "",
            "imageChoices_columnsWidth": "",
            "imageChoices_columnsWidthMedium": "",
            "imageChoices_columnsWidthSmall": "",
            "imageChoices_columns": "form_setting",
            "imageChoices_columnsMedium": "form_setting",
            "imageChoices_columnsSmall": "form_setting",
            "layoutGridColumnSpan": 12,
            "enableAutocomplete": false,
            "autocompleteAttribute": ""
        },
        {
            "type": "email",
            "id": 2,
            "label": "Email",
            "adminLabel": "",
            "isRequired": true,
            "size": "medium",
            "errorMessage": "",
            "inputs": null,
            "formId": 519,
            "description": "",
            "allowsPrepopulate": false,
            "inputMask": false,
            "inputMaskValue": "",
            "inputType": "email",
            "labelPlacement": "hidden_label",
            "descriptionPlacement": "",
            "subLabelPlacement": "",
            "placeholder": "Email",
            "cssClass": "",
            "inputName": "",
            "visibility": "visible",
            "noDuplicates": true,
            "defaultValue": "",
            "choices": "",
            "conditionalLogic": "",
            "productField": "",
            "emailConfirmEnabled": "",
            "multipleFiles": false,
            "maxFiles": "",
            "calculationFormula": "",
            "calculationRounding": "",
            "enableCalculation": "",
            "disableQuantity": false,
            "displayAllCategories": false,
            "useRichTextEditor": false,
            "displayOnly": "",
            "pageNumber": 1,
            "fields": "",
            "personalDataExport": "1",
            "personalDataErase": "1",
            "inputMaskIsCustom": false,
            "maxLength": "",
            "layoutGroupId": "8acd4772",
            "autocompleteAttribute": "",
            "imageChoices_enableImages": false,
            "imageChoices_useLightboxCaption": true,
            "imageChoices_theme": "form_setting",
            "imageChoices_featureColorCustom": "",
            "imageChoices_featureColor": "form_setting",
            "imageChoices_align": "form_setting",
            "imageChoices_imageStyle": "form_setting",
            "imageChoices_height": "",
            "imageChoices_heightMedium": "",
            "imageChoices_heightSmall": "",
            "imageChoices_columnsWidth": "",
            "imageChoices_columnsWidthMedium": "",
            "imageChoices_columnsWidthSmall": "",
            "imageChoices_columns": "form_setting",
            "imageChoices_columnsMedium": "form_setting",
            "imageChoices_columnsSmall": "form_setting",
            "enableAutocomplete": false
        }
    ],
    "version": "2.9.2",
    "id": 519,
    "enableHoneypot": true,
    "useCurrentUserAsAuthor": true,
    "postContentTemplateEnabled": false,
    "postTitleTemplateEnabled": false,
    "postTitleTemplate": "",
    "postContentTemplate": "",
    "lastPageButton": null,
    "pagination": null,
    "firstPageCssClass": null,
    "subLabelPlacement": "below",
    "cssClass": "",
    "enableAnimation": false,
    "save": {
        "enabled": false,
        "button": {
            "type": "link",
            "text": ""
        }
    },
    "limitEntries": false,
    "limitEntriesCount": "",
    "limitEntriesPeriod": "",
    "limitEntriesMessage": "",
    "scheduleForm": false,
    "scheduleStart": "",
    "scheduleStartHour": "",
    "scheduleStartMinute": "",
    "scheduleStartAmpm": "",
    "scheduleEnd": "",
    "scheduleEndHour": "",
    "scheduleEndMinute": "",
    "scheduleEndAmpm": "",
    "schedulePendingMessage": "",
    "scheduleMessage": "",
    "requireLogin": false,
    "requireLoginMessage": "",
    "is_active": "1",
    "date_created": "2025-09-03 14:37:20",
    "is_trash": "0",
    "personalData": {
        "exportingAndErasing": {
            "columns": {
                "ip": {
                    "export": "1",
                    "erase": "1"
                },
                "source_url": {
                    "export": "1",
                    "erase": "1"
                },
                "user_agent": {
                    "export": "1",
                    "erase": "1"
                }
            },
            "enabled": "1",
            "identificationField": 2
        }
    },
    "nextFieldId": 3,
    "recaptcha": "1",
    "requiredIndicator": "asterisk",
    "submitBGcolor": "#4361ee",
    "submitTextColor": "#ffffff",
    "markupVersion": 2,
    "saveButtonText": "",
    "email_text": "A message has been sent to verify your email address",
    "verified_text": "Your email address has been verified",
    "saveEnabled": "",
    "country_restriction": "",
    "email_enabled": "",
    "personality_quiz": "",
    "validationPlacement": "below",
    "validationSummary": false,
    "customRequiredIndicator": "",
    "honeypotAction": "abort",
    "notifications": [],
    "confirmations": {
        "5824c6ae1a447": {
            "id": "5824c6ae1a447",
            "name": "Default Confirmation",
            "isDefault": true,
            "type": "message",
            "message": "<h2 style=\"text-align: center\">{Name (First):1.3}, thanks for subscribing!</h2>",
            "url": "",
            "pageId": "",
            "queryString": "",
            "disableAutoformat": false,
            "conditionalLogic": [],
            "event": ""
        }
    }
}

Create a form

POST /forms

Request parameters

ParameterTypeRequiredDescription
titlestringyesThe form title.
adminLabelstringnoWhen specified, the value of this property will be used on the admin pages instead of the label. It is useful for fields with long labels. Applies to: All fields
adminOnlyboolnoDetermines if this field should only visible on the administration pages. A value of 1 will mark the field as admin only and will hide it from the public form. Useful for fields such as “status” that help with managing entries, but don’t apply to users filling out the form. Applies to: All fields
allowsPrepopulateboolnoDetermines if the field’s value can be pre-populated dynamically. 1 to allow field to be pre-populated, 0 otherwise. Applies to: All fields
choicesarraynoAn array of choices. See Choice Parameters bellow for how each choice in the array should be defined. Applies to: checkboxes, radio, select, and post_category
Conditional LogicarraynoControls the visibility of the field based on values selected by the user.
contentstringnoContent of an HTML block field to be displayed on the form. Applies to: html
cssClassstringnoCustom CSS class to be added to the <li> tag that contains the field. Useful to apply custom formatting to specific fields. Applies to: All fields
defaultValuestringnoContains the default value for the field. When specified, the field’s value will be populated with the contents of this property when the form is displayed. Applies to: hidden, text, website, phone, number, date, textarea, email
descriptionstringnoField description. Applies to: All fields
enableChoiceValueboolnoDetermines if the field (checkbox, select or radio) have choice values enabled, which allows the field to have choice values different from the labels that are displayed to the user. Applies to: checkbox, select and radio
errorMessagestringnoContains the message that is displayed for fields that fail validation. Applies to: All fields except html, section and hidden
idintegernoField id
inputNamestringnoAssigns a name to this field so that it can be populated dynamically via this input name. Only applicable when allowsPrepopulate is set to 1. Applies to: All fields except section
inputsarraynoAn array of inputs. See Input Parameters bellow for how each input should be defined. Applies to: name, address, checkbox. Note: For checkbox fields, there should be an input for each choice.
isRequiredboolnoDetermines if the field requires the user to enter a value. 1 marks the field as required, 0 marks the field as not required. Fields marked as required will prevent the form from being submitted if the user has not entered a value in it. Applies to: All fields except section, html
labelstringnoField label that will be displayed on the form and on the admin pages. Applies to: All fields
noDuplicatesboolnoDetermines if the field allows duplicate submissions. 1 to prevent users from submitting the same value more than once, 0 to allow duplicate values. Applies to: hidden, text, website, phone, number, date, time, textarea, select, radio, email
sizestringnoDetermines the size of the field when displayed on the page. Applies to: All fields except html and section. Possible values: small, medium, large
typestringnoThe type of field to be displayed. Applies to: All fields. Possible values: html, hidden, section, text, website, phone, number, date, time, textarea, select, checkbox, radio, name, address, fileupload, email
placeholderstringnoUse the Placeholder to give a hint at the expected value or format. Applies to: All fields except section, HTML, hidden, radio buttons, checkbox, multiple choice, image choice, page
choiceAlignmentstringnoThe alignment for choices. Applies to: multiple choice field. Possible values: horizontal, vertical

Choice parameters

ParameterTypeRequiredDescription
textstringyesThe text to be displayed to the user when displaying this choice.
valuestringyesThe value to be stored in the database when this choice is selected.
isSelectedboolnoIndicates if the choice should be selected by default when the field is displayed.
pricestringnoThe price of the item. Used by Product, Option, and Shipping type fields.

Input parameters

ParameterTypeRequiredDescription
idstringyesThe input ID. Follows the naming convention: FIELDID.NUMBER (e.g. 5.1), where FIELDID is the id of the containing field, and NUMBER is a unique value that does not end with 0.
labelstringyesThe input label.
nameboolyesThe input parameter name for use with dynamic population.

Response

{
    "title": "Newsletter Signup Form",
    "description": "",
    "labelPlacement": "top_label",
    "descriptionPlacement": "below",
    "button": {
        "type": "text",
        "text": "Subscribe",
        "imageUrl": "",
        "width": "auto",
        "location": "bottom",
        "layoutGridColumnSpan": 12,
        "id": "submit"
    },
    "fields": [
        {
            "type": "name",
            "id": 1,
            "label": "Name",
            "adminLabel": "",
            "isRequired": true,
            "size": "medium",
            "errorMessage": "",
            "nameFormat": "advanced",
            "inputs": [
                {
                    "id": "1.2",
                    "label": "Prefix",
                    "name": "",
                    "choices": [
                        {
                            "text": "Mr.",
                            "value": "Mr.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Mrs.",
                            "value": "Mrs.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Miss",
                            "value": "Miss",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Ms.",
                            "value": "Ms.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Dr.",
                            "value": "Dr.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Prof.",
                            "value": "Prof.",
                            "isSelected": false,
                            "price": ""
                        },
                        {
                            "text": "Rev.",
                            "value": "Rev.",
                            "isSelected": false,
                            "price": ""
                        }
                    ],
                    "isHidden": true,
                    "inputType": "radio"
                },
                {
                    "id": "1.3",
                    "label": "First",
                    "name": "",
                    "placeholder": "First Name",
                    "autocompleteAttribute": "given-name"
                },
                {
                    "id": "1.4",
                    "label": "Middle",
                    "name": "",
                    "isHidden": true
                },
                {
                    "id": "1.6",
                    "label": "Last",
                    "name": "",
                    "placeholder": "Last Name",
                    "autocompleteAttribute": "family-name"
                },
                {
                    "id": "1.8",
                    "label": "Suffix",
                    "name": "",
                    "isHidden": true
                }
            ],
            "formId": 519,
            "description": "",
            "allowsPrepopulate": false,
            "inputMask": false,
            "inputMaskValue": "",
            "inputType": "name",
            "labelPlacement": "hidden_label",
            "descriptionPlacement": "",
            "subLabelPlacement": "hidden_label",
            "placeholder": "",
            "cssClass": "",
            "inputName": "",
            "visibility": "visible",
            "noDuplicates": false,
            "defaultValue": "",
            "choices": "",
            "conditionalLogic": "",
            "productField": "",
            "multipleFiles": false,
            "maxFiles": "",
            "calculationFormula": "",
            "calculationRounding": "",
            "enableCalculation": "",
            "disableQuantity": false,
            "displayAllCategories": false,
            "useRichTextEditor": false,
            "displayOnly": "",
            "pageNumber": 1,
            "fields": "",
            "personalDataExport": "1",
            "personalDataErase": "1",
            "inputMaskIsCustom": false,
            "maxLength": "",
            "layoutGroupId": "abc8be7f",
            "imageChoices_enableImages": false,
            "imageChoices_useLightboxCaption": true,
            "imageChoices_theme": "form_setting",
            "imageChoices_featureColorCustom": "",
            "imageChoices_featureColor": "form_setting",
            "imageChoices_align": "form_setting",
            "imageChoices_imageStyle": "form_setting",
            "imageChoices_height": "",
            "imageChoices_heightMedium": "",
            "imageChoices_heightSmall": "",
            "imageChoices_columnsWidth": "",
            "imageChoices_columnsWidthMedium": "",
            "imageChoices_columnsWidthSmall": "",
            "imageChoices_columns": "form_setting",
            "imageChoices_columnsMedium": "form_setting",
            "imageChoices_columnsSmall": "form_setting",
            "layoutGridColumnSpan": 12,
            "enableAutocomplete": false,
            "autocompleteAttribute": ""
        },
        {
            "type": "email",
            "id": 2,
            "label": "Email",
            "adminLabel": "",
            "isRequired": true,
            "size": "medium",
            "errorMessage": "",
            "inputs": null,
            "formId": 519,
            "description": "",
            "allowsPrepopulate": false,
            "inputMask": false,
            "inputMaskValue": "",
            "inputType": "email",
            "labelPlacement": "hidden_label",
            "descriptionPlacement": "",
            "subLabelPlacement": "",
            "placeholder": "Email",
            "cssClass": "",
            "inputName": "",
            "visibility": "visible",
            "noDuplicates": true,
            "defaultValue": "",
            "choices": "",
            "conditionalLogic": "",
            "productField": "",
            "emailConfirmEnabled": "",
            "multipleFiles": false,
            "maxFiles": "",
            "calculationFormula": "",
            "calculationRounding": "",
            "enableCalculation": "",
            "disableQuantity": false,
            "displayAllCategories": false,
            "useRichTextEditor": false,
            "displayOnly": "",
            "pageNumber": 1,
            "fields": "",
            "personalDataExport": "1",
            "personalDataErase": "1",
            "inputMaskIsCustom": false,
            "maxLength": "",
            "layoutGroupId": "8acd4772",
            "autocompleteAttribute": "",
            "imageChoices_enableImages": false,
            "imageChoices_useLightboxCaption": true,
            "imageChoices_theme": "form_setting",
            "imageChoices_featureColorCustom": "",
            "imageChoices_featureColor": "form_setting",
            "imageChoices_align": "form_setting",
            "imageChoices_imageStyle": "form_setting",
            "imageChoices_height": "",
            "imageChoices_heightMedium": "",
            "imageChoices_heightSmall": "",
            "imageChoices_columnsWidth": "",
            "imageChoices_columnsWidthMedium": "",
            "imageChoices_columnsWidthSmall": "",
            "imageChoices_columns": "form_setting",
            "imageChoices_columnsMedium": "form_setting",
            "imageChoices_columnsSmall": "form_setting",
            "enableAutocomplete": false
        }
    ],
    "version": "2.9.2",
    "id": 519,
    "enableHoneypot": true,
    "useCurrentUserAsAuthor": true,
    "postContentTemplateEnabled": false,
    "postTitleTemplateEnabled": false,
    "postTitleTemplate": "",
    "postContentTemplate": "",
    "lastPageButton": null,
    "pagination": null,
    "firstPageCssClass": null,
    "subLabelPlacement": "below",
    "cssClass": "",
    "enableAnimation": false,
    "save": {
        "enabled": false,
        "button": {
            "type": "link",
            "text": ""
        }
    },
    "limitEntries": false,
    "limitEntriesCount": "",
    "limitEntriesPeriod": "",
    "limitEntriesMessage": "",
    "scheduleForm": false,
    "scheduleStart": "",
    "scheduleStartHour": "",
    "scheduleStartMinute": "",
    "scheduleStartAmpm": "",
    "scheduleEnd": "",
    "scheduleEndHour": "",
    "scheduleEndMinute": "",
    "scheduleEndAmpm": "",
    "schedulePendingMessage": "",
    "scheduleMessage": "",
    "requireLogin": false,
    "requireLoginMessage": "",
    "is_active": "1",
    "date_created": "2025-09-03 14:37:20",
    "is_trash": "0",
    "personalData": {
        "exportingAndErasing": {
            "columns": {
                "ip": {
                    "export": "1",
                    "erase": "1"
                },
                "source_url": {
                    "export": "1",
                    "erase": "1"
                },
                "user_agent": {
                    "export": "1",
                    "erase": "1"
                }
            },
            "enabled": "1",
            "identificationField": 2
        }
    },
    "nextFieldId": 3,
    "recaptcha": "1",
    "requiredIndicator": "asterisk",
    "submitBGcolor": "#4361ee",
    "submitTextColor": "#ffffff",
    "markupVersion": 2,
    "saveButtonText": "",
    "email_text": "A message has been sent to verify your email address",
    "verified_text": "Your email address has been verified",
    "saveEnabled": "",
    "country_restriction": "",
    "email_enabled": "",
    "personality_quiz": "",
    "validationPlacement": "below",
    "validationSummary": false,
    "customRequiredIndicator": "",
    "honeypotAction": "abort",
    "notifications": [],
    "confirmations": {
        "5824c6ae1a447": {
            "id": "5824c6ae1a447",
            "name": "Default Confirmation",
            "isDefault": true,
            "type": "message",
            "message": "<h2 style=\"text-align: center\">{Name (First):1.3}, thanks for subscribing!</h2>",
            "url": "",
            "pageId": "",
            "queryString": "",
            "disableAutoformat": false,
            "conditionalLogic": [],
            "event": ""
        }
    }
}

Update a form

PUT /forms/{form_id}

Request parameters

ParameterTypeRequiredDescription
titlestringnoThe form title.
adminLabelstringnoWhen specified, the value of this property will be used on the admin pages instead of the label. It is useful for fields with long labels. Applies to: All fields
adminOnlyboolnoDetermines if this field should only visible on the administration pages. A value of 1 will mark the field as admin only and will hide it from the public form. Useful for fields such as “status” that help with managing entries, but don’t apply to users filling out the form. Applies to: All fields
allowsPrepopulateboolnoDetermines if the field’s value can be pre-populated dynamically. 1 to allow field to be pre-populated, 0 otherwise. Applies to: All fields
choicesarraynoAn array of choices. See Choice Parameters bellow for how each choice in the array should be defined. Applies to: checkboxes, radio, select, and post_category
Conditional LogicarraynoControls the visibility of the field based on values selected by the user.
contentstringnoContent of an HTML block field to be displayed on the form. Applies to: html
cssClassstringnoCustom CSS class to be added to the <li> tag that contains the field. Useful to apply custom formatting to specific fields. Applies to: All fields
defaultValuestringnoContains the default value for the field. When specified, the field’s value will be populated with the contents of this property when the form is displayed. Applies to: hidden, text, website, phone, number, date, textarea, email
descriptionstringnoField description. Applies to: All fields
enableChoiceValueboolnoDetermines if the field (checkbox, select or radio) have choice values enabled, which allows the field to have choice values different from the labels that are displayed to the user. Applies to: checkbox, select and radio
errorMessagestringnoContains the message that is displayed for fields that fail validation. Applies to: All fields except html, section and hidden
idintegernoField id
inputNamestringnoAssigns a name to this field so that it can be populated dynamically via this input name. Only applicable when allowsPrepopulate is set to 1. Applies to: All fields except section
inputsarraynoAn array of inputs. See Input Parameters bellow for how each input should be defined. Applies to: name, address, checkbox. Note: For checkbox fields, there should be an input for each choice.
isRequiredboolnoDetermines if the field requires the user to enter a value. 1 marks the field as required, 0 marks the field as not required. Fields marked as required will prevent the form from being submitted if the user has not entered a value in it. Applies to: All fields except section, html
labelstringnoField label that will be displayed on the form and on the admin pages. Applies to: All fields
noDuplicatesboolnoDetermines if the field allows duplicate submissions. 1 to prevent users from submitting the same value more than once, 0 to allow duplicate values. Applies to: hidden, text, website, phone, number, date, time, textarea, select, radio, email
sizestringnoDetermines the size of the field when displayed on the page. Applies to: All fields except html and section. Possible values: small, medium, large
typestringnoThe type of field to be displayed. Applies to: All fields. Possible values: html, hidden, section, text, website, phone, number, date, time, textarea, select, checkbox, radio, name, address, fileupload, email
placeholderstringnoUse the Placeholder to give a hint at the expected value or format. Applies to: All fields except section, HTML, hidden, radio buttons, checkbox, multiple choice, image choice, page
choiceAlignmentstringnoThe alignment for choices. Applies to: multiple choice field. Possible values: horizontal, vertical

Choice parameters

ParameterTypeRequiredDescription
textstringyesThe text to be displayed to the user when displaying this choice.
valuestringyesThe value to be stored in the database when this choice is selected.
isSelectedboolnoIndicates if the choice should be selected by default when the field is displayed.
pricestringnoThe price of the item. Used by Product, Option, and Shipping type fields.

Input parameters

ParameterTypeRequiredDescription
idstringyesThe input ID. Follows the naming convention: FIELDID.NUMBER (e.g. 5.1), where FIELDID is the id of the containing field, and NUMBER is a unique value that does not end with 0.
labelstringyesThe input label.
nameboolyesThe input parameter name for use with dynamic population.

Delete a form

Use this DELETE request to delete a form

DELETE /forms/{form_id}

The id must a valid form id that belongs to the account.

Request parameters

ParameterTypeRequiredDescription
forceintegernoDefault is 0. Set to 1 in order to permanently delete the form.

Join more than 80,000 brands using Woorise

Easily create landing pages, forms, surveys, quizzes & viral giveaways that drive real user engagement.