Clone Form

Creates a cloned copy of an existing form.

POST/api/restricted/form/{formId}/clone


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{4ee2bb21-2260-4e43-854c-94da49c13d84}/clone' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX'

Response 200 OK

{
    "id": "da94b960-4822-4447-bc3f-9ff8b65af8a6",
    "message": "Form cloned successfully",
    "action_successful": true,
    "error": ""
}

Notes

The response "id" property is the "id" of the newly created form

Update Form - Conditional Logic Settings

Updates the conditional logic settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=conditionallogicsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=conditionallogicsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "enable_logic_settings": true,
  "conditional_logic": {
    "field_rules": [
      {
        "rule_json_object": {
          "rules": [
            {
              "id": "gpi_1698219261413",
              "field": "gpi_1698219261413",
              "type": "string",
              "input": "text",
              "operator": "is_not_empty",
              "value": null
            }
          ],
          "condition": "AND",
          "valid": true
        },
        "field_actions": [
          {
            "action": "show_required",
            "form_field_id": "gpi_1698283416152",
            "form_field_value": "",
            "form_field_value_source": ""
          }
        ]
      }
    ]
  }
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Quantity Limit & Inventory Settings

Updates the quantity limit and inventory settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=quantitylimitsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=quantitylimitsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "form_submission_limit_per_form_enabled": true,
  "form_submission_limit_per_form_quantity": "1000",
  "form_submission_limit_per_logged_in_user_enabled": true,
  "form_submission_limit_per_logged_in_user_quantity": "1",
  "form_submission_limits_per_form_field_values_enabled": true,
  "form_submission_limits_per_form_field_values": [
    {
      "form_field_system_name": "gpi_1698283741875",
      "form_field_submitted_value": "true",
      "quantity_limit": "100",
      "stock_usage_quantity_per_submit": "1"
    }
  ]
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Calculated Fields Settings

Updates the calculated fields of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=calculatedfieldsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=calculatedfieldsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "form_calculated_fields": [
    {
      "field_system_name": "gpi_1698283741915",
      "equation": "( [gpi_1698283741912] * [gpi_1698283741909] ) + 12.99 (decimal:2)"
    }
  ]
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Payment Settings

Updates the payment settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=paymentsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=paymentsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "enable_form_payment": true,
  "payment_type_field_system_name": null,
  "total_price_field_system_name": "gpi_1698283741915",
  "total_price_currency_code": "USD",
  "sale_description": "Sale description goes here",
  "payment_type": "once",
  "payment_frequency": "month",
  "payment_recurrence_limit": "nolimit",
  "total_price_uses_fixed_amount": false,
  "total_price_fixed_amount": 0
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Security Settings

Updates the security settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=securitysettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=securitysettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "login_required": true,
  "login_required_specific": false,
  "password_required": true,
  "form_password": "mynewpassword",
  "enable_spam_bot_protection": true,
  "enable_save_resume": true
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Data Destination Settings

Updates the data destination settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=destinationsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=destinationsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "form_destination_cloud_used": true,
  "form_destination_email_used": true,
  "form_destination_email_address": "[email protected]",
  "form_destination_custom_url_used": true,
  "form_destination_custom_url": "https://your-destination-api-here/",
  "form_destination_custom_url_http_header_key": "HeaderName",
  "form_destination_custom_url_http_header_value": "HeaderValue"
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Thanks Page Settings

Updates the thanks page settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=thankspagesettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=thankspagesettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example for "Inline" thanks page:

{
  "thanks_behaviour": "inline_message",
  "thanks_behaviour_message": "Form submitted successfully. Thank you",
  "thanks_behaviour_redirect_url": "",
  "thanks_behaviour_redirect_url_params": [],
  "thanks_behaviour_conditional_urls": [],
  "thanks_behaviour_redirect_parent_page": false
}

Payload Example for "Redirect" thanks page with conditional redirect rules and params passed from the form to the thanks page:

{
  "thanks_behaviour": "url_redirect",
  "thanks_behaviour_message": "Form submitted successfully. Thank you",
  "thanks_behaviour_redirect_url": "https://your-thanks-page-url.com",
  "thanks_behaviour_redirect_url_params": [
    {
      "param_name": "param1",
      "param_value_form_field_system_name": "",
      "param_value_fixed": "fixed-value-here"
    },
    {
      "param_name": "param2",
      "param_value_form_field_system_name": "gpi_1698283741891",
      "param_value_fixed": ""
    }
  ],
  "thanks_behaviour_conditional_urls": [
    {
      "form_field_system_name": "gpi_1698283741897",
      "condition_operator": "equal",
      "condition_value_fixed": "happy",
      "conditional_url": "https://your-conditional-thanks-page-url.com"
    }
  ],
  "thanks_behaviour_redirect_parent_page": true
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Confirmation Email Settings

Updates the confirmation email settings of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=confirmationemailsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=confirmationemailsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "auto_email_reply": true,
  "auto_email_reply_trigger": "submit",
  "auto_email_reply_sender_name": "Sender name goes here",
  "auto_email_reply_sender_email": "[email protected]",
  "auto_email_reply_email_subject": "Subject goes here",
  "auto_email_reply_email_message": "Dear {{gpi_1698283416152}},\n\nThank you for your order.\n\nKind Regards,\n\nSupport Team",
  "auto_email_reply_recipient_field": "gpi_1698219261413",
  "auto_email_reply_replyto_email": "[email protected]",
  "auto_email_reply_bcc_email": ""
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Dynamically Populated Droplists Settings

Updates the settings for all dynamically populated droplists of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=dynamicdatafieldsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=dynamicdatafieldsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "dynamic_data_fields": [
    {
      "field_system_name": "gpi_1698283741885",
      "all_parent_values_required": true,
      "use_external_datasource": true,
      "external_datasource_url": "https://your-public-api-data-source-url.com",
      "external_datasource_type": "public_api",
      "parent_field_system_names": []
    },
    {
      "field_system_name": "gpi_1698283741891",
      "all_parent_values_required": true,
      "use_external_datasource": true,
      "external_datasource_url": "https://your-public-google-sheet-data-source-url.com",
      "external_datasource_type": "public_google_sheet",
      "parent_field_system_names": []
    }
  ]
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - Datalist Logic Settings

Updates the datalist logic of an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=privatedatalistlogicsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=privatedatalistlogicsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "private_datalist_logic": {
    "submission_rules": [
      {
        "rule_json_object": {
          "rules": [
            {
              "id": "6f218592-4ac8-41f7-bdfa-c2c40f50c22b",
              "field": "6f218592-4ac8-41f7-bdfa-c2c40f50c22b",
              "type": "string",
              "input": "select",
              "operator": "not_contains",
              "value": "gpi_1698219261413"
            }
          ],
          "condition": "AND",
          "valid": true
        },
        "submission_actions": [
          {
            "action": "add_to_list",
            "form_field_id": "gpi_1698283741891",
            "private_datalist_id": "6f218592-4ac8-41f7-bdfa-c2c40f50c22b",
            "message": ""
          }
        ]
      },
      {
        "rule_json_object": {
          "rules": [
            {
              "id": "6f218592-4ac8-41f7-bdfa-c2c40f50c22b",
              "field": "6f218592-4ac8-41f7-bdfa-c2c40f50c22b",
              "type": "string",
              "input": "select",
              "operator": "contains",
              "value": "gpi_1698219261413"
            }
          ],
          "condition": "AND",
          "valid": true
        },
        "submission_actions": [
          {
            "action": "block_submission",
            "form_field_id": "",
            "private_datalist_id": "",
            "message": ""
          }
        ]
      }
    ]
  }
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

Update Form - General Settings

Updates the general settings of an existing form such as the name, description, Google analytics, and whether the form is disabled or not.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=generalsettings


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=generalsettings' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX' \

										--header 'Content-Type: application/json' \

										--data '{ JSON_PAYLOAD_HERE }'

Payload Example:

{
  "form_name": "Form name goes here",
  "form_description": "Form description goes here",
  "disable_web_hosted_form": false,
  "enable_google_tracking": true,
  "google_tracking_type": "ga",
  "google_tracking_id": "G-XXXXXXXXXX"
}

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}

List Accessible Forms

Retrieves a list of all forms that you have access to in your account, including the access levels for those forms

GET/api/restricted/user/form


										curl --request GET 'https://api.globalpatron.com/api/restricted/user/form' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX'

Response 200 OK

{
    "results": [
        {
            "form_configuration": {
                "settings": {
                    "form_name": "My first conversational form",
                    "form_description": "This form has a description",
                    "form_type": "conversational",
                    "form_system_version": 2
                }
            },
            "id": "11111111-1111-1111-1111-111111111111",
            "created_date_utc": "2023-01-25T01:53:16.5721153Z",
            "modified_date_utc": "2023-10-25T03:19:08.9169382Z"
        },
        {
            "form_configuration": {
                "settings": {
                    "form_name": "My first classic form",
                    "form_type": "classicsingle",
                    "form_system_version": 2
                }
            },
            "id": "22222222-2222-2222-2222-222222222222",
            "created_date_utc": "2023-05-23T05:36:11.5262493Z",
            "modified_date_utc": "2023-10-25T12:35:07.8479111Z"
        },
        {
            "form_configuration": {
                "settings": {
                    "form_name": "My second classic form",
                    "form_description": "This form has a description",
                    "form_type": "classicsingle",
                    "form_system_version": 2
                }
            },
            "id": "33333333-3333-3333-33333-33333333333",
            "created_date_utc": "2023-07-25T02:25:59.5289813Z",
            "modified_date_utc": "2023-10-25T13:16:18.5356039Z"
        }
    ],
    "accessible_form_ids_edit_access": [
        "11111111-1111-1111-1111-111111111111",
        "22222222-2222-2222-2222-222222222222",
        "33333333-3333-3333-33333-33333333333"
    ],
    "accessible_form_ids_account_management_access": [
        "22222222-2222-2222-2222-222222222222"
    ],
    "accessible_form_ids_full_reporting_access": [
        "33333333-3333-3333-33333-33333333333"
    ]
}

Retrieve Form JSON (For Render)

Retrieves the JSON definition of a form for rendering view

GET/api/form/{formId}


										curl --request GET 'https://api.globalpatron.com/api/form/{09e76904-4a01-4141-9c21-95c1843b4dd0}' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX'

Response 200 OK

{
    "form_definition": {
        ...
    }
}

Delete Form

Deletes an existing form.

POST/api/restricted/form/{formId}/?updateSettingsOnly=1&settingsSection=generalsettingsdelete


										curl --request POST 'https://api.globalpatron.com/api/restricted/form/{80da8cb8-8aac-4911-8167-5ce887823387}/?updateSettingsOnly=1&settingsSection=generalsettingsdelete' \

										--header 'TokenId: XXXXX' \

										--header 'TokenSecret: XXXXX'

Response 200 OK

{
    "id": "",
    "message": "Form updated successfully",
    "action_successful": true,
    "error": ""
}