Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Form Handler API

Create a form submission via the public API endpoint.

POST Form Handler

Sends form submission data to an existing form.

/api/v2/frontend/form-handler

Data / Response:

FormSubmissionData with FormId as required field

{
  "Id": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "CreatedDateTime": "2024-05-22T17:39:49.982Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "CaseFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}
Validation:

Data validation will be performed as per the server side validation rules for the form, except for:

  1. Recaptcha validation
  2. Payment processing
  3. If form type is one of the following; Checkout, Quote, Reccurring:
    • Error message: Form with "Checkout" or "Quote" form type is not allowed to be submitted via the current API endpoint
Flow
  • Autoresponder assigned to the Form will be sent.
  • Workflows assigned to the Form wil be sent.
  • Secure Zones assigned to the Form should be applied to the CRM Contact - except when Secure Zones are recurring (recurrign zones will not be applied).
  • Contact record should be created (if contact does not exist).
  • CRM Form Submission (Case) record will be created.
  • If form type is SingleItem and form has Accept event bookings field:
    • Create CRM Event Booking
    • Require following form fields
      • Payment_ModuleItemId
      • Payment_ItemQuantity