Change Log

  • 04-Jun-2026 | v7.10.7 | Added all new endpoints from v7.4 release
  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Forms API

Create, Retrieve, Update and Delete Forms via the public API endpoint using "where" filtering, as well as retrieve a Form's Settings and Template. The Form's Field Groups, Field Types, Recurring Types and Form Types can also be retrieved, and a Form Template can be generated via this API.

GET Forms List

Retrieves a list of Forms as a JSON response based on your provided query parameters.

/api/v2/admin/forms

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "Alias": "string",
      "Type": "Generic",
      "IsSendConfirmEmailNotification": true,
      "IsSendSecureZoneLoginDetailsEmail": true,
      "IsSecureSubmission": true,
      "SubmissionFolderPath": "string",
      "FtpPath": "string",
      "CreatedDateTime": "2024-01-01T00:00:00.000Z",
      "EnabledAutoresponder": true,
      "Template": "string",
      "RecurringType": "None",
      "EnableDefaultJSValidation": true,
      "SecureZoneIds": [
        0
      ],
      "CustomWorkflowIds": [
        0
      ],
      "FormFields": [
        {
          "Id": 0,
          "IsMandatory": true,
          "Name": "string",
          "Alias": "string",
          "IsEditable": true,
          "IsComposite": true,
          "Type": "System",
          "Properties": [
            {
              "Name": "string",
              "Alias": "string",
              "Type": "DateTime",
              "IsMandatory": true,
              "Options": [
                "string"
              ]
            }
          ]
        }
      ],
      "FormAutoresponder": {
        "FromName": "string",
        "FromEmail": "user@example.com",
        "Subject": "string",
        "Body": "string",
        "TemplateId": 0,
        "EnableEditor": true
      }
    }
  ],
  "TotalItemsCount": 0
}

POST Form Create

Creates a new Form based on the provided data.

/api/v2/admin/forms

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "Type": "Generic",
  "RecurringType": "None",
  "FormFields": [
    {
      "Name": "string",
      "Alias": "string",
      "IsEditable": true,
      "IsComposite": true,
      "Type": "System",
      "Properties": [
        {
          "Name": "string",
          "Alias": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ]
}

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Type": "Generic",
  "IsSendConfirmEmailNotification": true,
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "FtpPath": "string",
  "CreatedDateTime": "2024-01-01T00:00:00.000Z",
  "EnabledAutoresponder": true,
  "Template": "string",
  "RecurringType": "None",
  "EnableDefaultJSValidation": true,
  "SecureZoneIds": [
    0
  ],
  "CustomWorkflowIds": [
    0
  ],
  "FormFields": [
    {
      "Id": 0,
      "IsMandatory": true,
      "Name": "string",
      "Alias": "string",
      "IsEditable": true,
      "IsComposite": true,
      "Type": "System",
      "Properties": [
        {
          "Name": "string",
          "Alias": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ],
  "FormAutoresponder": {
    "FromName": "string",
    "FromEmail": "user@example.com",
    "Subject": "string",
    "Body": "string",
    "TemplateId": 0,
    "EnableEditor": true
  }
}

GET Form Item

Retrieves a single Form based on the ID passed in the endpoint URL.

/api/v2/admin/forms/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Type": "Generic",
  "IsSendConfirmEmailNotification": true,
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "FtpPath": "string",
  "CreatedDateTime": "2024-01-01T00:00:00.000Z",
  "EnabledAutoresponder": true,
  "Template": "string",
  "RecurringType": "None",
  "EnableDefaultJSValidation": true,
  "SecureZoneIds": [
    0
  ],
  "CustomWorkflowIds": [
    0
  ],
  "FormFields": [
    {
      "Id": 0,
      "IsMandatory": true,
      "Name": "string",
      "Alias": "string",
      "IsEditable": true,
      "IsComposite": true,
      "Type": "System",
      "Properties": [
        {
          "Name": "string",
          "Alias": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ],
  "FormAutoresponder": {
    "FromName": "string",
    "FromEmail": "user@example.com",
    "Subject": "string",
    "Body": "string",
    "TemplateId": 0,
    "EnableEditor": true
  }
}

PUT Form Update

Updates a single Form based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/forms/{id}

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "Type": "Generic",
  "RecurringType": "None",
  "FormFields": [
    {
      "Id": 0,
      "IsMandatory": true,
      "Name": "string",
      "Alias": "string",
      "IsEditable": true,
      "IsComposite": true,
      "Type": "System",
      "Properties": [
        {
          "Name": "string",
          "Alias": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ]
}

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Type": "Generic",
  "IsSendConfirmEmailNotification": true,
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "FtpPath": "string",
  "CreatedDateTime": "2024-01-01T00:00:00.000Z",
  "EnabledAutoresponder": true,
  "Template": "string",
  "RecurringType": "None",
  "EnableDefaultJSValidation": true,
  "SecureZoneIds": [
    0
  ],
  "CustomWorkflowIds": [
    0
  ],
  "FormFields": [
    {
      "Id": 0,
      "IsMandatory": true,
      "Name": "string",
      "Alias": "string",
      "IsEditable": true,
      "IsComposite": true,
      "Type": "System",
      "Properties": [
        {
          "Name": "string",
          "Alias": "string",
          "Type": "DateTime",
          "IsMandatory": true,
          "Options": [
            "string"
          ]
        }
      ]
    }
  ],
  "FormAutoresponder": {
    "FromName": "string",
    "FromEmail": "user@example.com",
    "Subject": "string",
    "Body": "string",
    "TemplateId": 0,
    "EnableEditor": true
  }
}

DELETE Form Delete

Deletes a single Form based on the ID passed in the endpoint URL.

/api/v2/admin/forms/{id}

Data / Response:

N/A

Status 204

GET Form Settings Item

Retrieves a single Form's Settings based on the ID passed in the endpoint URL.

/api/v2/admin/forms/{id}/settings

Data / Response:

N/A

{
  "IsEnabled": true,
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "EnableEditor": true,
  "EnableDefaultJSValidation": true,
  "Body": "string",
  "TemplateId": 0,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "CustomWorkflowIds": [
    0
  ],
  "SecureZoneIds": [
    0
  ],
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSendConfirmEmailNotification": true
}

PUT Form Settings Update

Updates a single Form's Settings based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/forms/{id}/settings

Data / Response:

{
  "IsEnabled": true,
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "EnableEditor": true,
  "EnableDefaultJSValidation": true,
  "Body": "string",
  "TemplateId": 0,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "CustomWorkflowIds": [
    0
  ],
  "SecureZoneIds": [
    0
  ],
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSendConfirmEmailNotification": true
}

{
  "IsEnabled": true,
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "EnableEditor": true,
  "EnableDefaultJSValidation": true,
  "Body": "string",
  "TemplateId": 0,
  "IsSecureSubmission": true,
  "SubmissionFolderPath": "string",
  "CustomWorkflowIds": [
    0
  ],
  "SecureZoneIds": [
    0
  ],
  "IsSendSecureZoneLoginDetailsEmail": true,
  "IsSendConfirmEmailNotification": true
}

GET Form Template Item

Retrieves a single Form's Template based on the ID passed in the endpoint URL.

/api/v2/admin/forms/{id}/template

Data / Response:

N/A

"string"

PUT Form Template Update

Updates a single Form's Template based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/forms/{id}/template

Data / Response:

{
  "Template": "string"
}

Status 200

POST Form Generate Template

Generates a template for a single Form based on the ID passed in the endpoint URL.

/api/v2/admin/forms/{id}/generate-template

Data / Response:

N/A

"string"

GET Form Field Groups List

Retrieves a list of a Form's Field Groups as a JSON response based on your provided query parameters.

/api/v2/admin/forms/field-groups

Parameters

Parameter
Values
Required
formType
<string>
includeCustomProperties
<boolean>

Data / Response:

N/A

[
  {
    "GroupName": "string",
    "Fields": [
      {
        "Name": "string",
        "Alias": "string",
        "IsEditable": true,
        "IsComposite": true,
        "GroupType": "System",
        "Properties": [
          {
            "Name": "string",
            "Alias": "string",
            "Type": "DateTime",
            "IsMandatory": true,
            "Options": [
              "string"
            ]
          }
        ]
      }
    ]
  }
]

GET Form Field Types List

Retrieves a list of available Form Field Types as a JSON response.

/api/v2/admin/forms/field-types

Data / Response:

N/A

[
  "string"
]

GET Form Recurring Types List

Retrieves a list of available Form Recurring Types as a JSON response.

/api/v2/admin/forms/recurring-types

Data / Response:

N/A

[
  {
    "AccessType": "None",
    "IsEnable": true,
    "DisplayName": "string"
  }
]

GET Form Types List

Retrieves a list of available Form Types as a JSON response.

/api/v2/admin/forms/types

Data / Response:

N/A

[
  {
    "DisplayName": "string",
    "Value": "string",
    "Type": "Generic"
  }
]