validateSubmission( )

Validates a form submission.

Description

Validates a site visitor's form submission and returns any validation violations.

Site visitors can see the validation violations on their forms. For example, notification messages can appear on the screen.

Syntax

function validateSubmission(options: Options): Promise<FormSubmissionResponse>

validateSubmission Parameters

NAME

TYPE

DESCRIPTION

options

Options

Submission validation options.

Returns

Fulfilled - Form submission validation violations.

Return Type:

Promise<FormSubmissionResponse>

Was this helpful?

Validate a form submission

This example validates a form submission. The message text box has a limitation of 200 characters.

Copy Code

1const options = {
2    "submission": {
3       "formId": "e9e8c6ff-a771-401b-b46e-82f7c742ef3d"
4    }
5}
6
7export const validateSubmission = async (options, context) => {
8    const messageValidation = options.submission.submissions["long_answer_3524"];
9    const messageLengthlimit = 200
10    if (messageValidation.length > messageLengthlimit) {
11        return {
12            errors: [{
13                errorPath: "long_answer_3524",
14                customErrorMessage: "Message cannot exceed 200 characters!",
15            }]
16        };
17    } else {
18        return {}
19    }
20};