confirmSubmission( )

Confirms a submission.

Note: The Submissions API is only available in Wix Studio and Editor X.

Description

You can only confirm a submission that has a PENDING status. When using forms from the Wix Pricing Plans app, the default submission status is PENDING. When using forms from the Wix Forms app, the default form submission status is CONFIRMED. You can change the default status for individual submissions using the updateSubmission() method.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse>

confirmSubmission Parameters

NAME

TYPE

DESCRIPTION

submissionId

string

Submission ID to confirm.

Returns

Return Type:

Promise<

ConfirmSubmissionResponse

NAME

TYPE

DESCRIPTION

submission

FormSubmission

The confirmed submission.

Was this helpful?

Confirm a submission (dashboard page code)

Copy Code

1import { submissions } from 'wix-forms.v2';
2
3/*
4Sample submissionId value: "f8281b62-1b2f-45bf-ba7d-f041d7653d2d"
5*/
6
7export async function myConfirmSubmissionFunction(submissionId) {
8  try {
9    const submission = await submissions.confirmSubmission(submissionId);
10    console.log('Success! Confirmed submission:', submission);
11    return submission;
12  } catch (error) {
13    console.error(error);
14    // Handle the error
15  }
16}
17
18/* Promise resolves to:
19{
20    "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
21    "namespace": "wix.form_app.form",
22    "status": "CONFIRMED",
23    "submissions": {
24        "last_name": "McBride",
25        "first_name": "Patsy"
26    },
27    "revision": "4",
28    "submitter": {
29        "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
30    },
31    "seen": true,
32    "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
33    "_createdDate": "2023-12-28T12:55:55.630Z",
34    "_updatedDate": "2023-12-28T13:42:24.853Z"
35}
36*/

Confirm a submission (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { submissions } from 'wix-forms.v2';
3import { elevate } from 'wix-auth';
4
5/*
6Sample submissionId value: "f8281b62-1b2f-45bf-ba7d-f041d7653d2d"
7*/
8
9export const myConfirmSubmissionFunction = webMethod(Permissions.Anyone, async (submissionId) => {
10  try {
11    const elevatedConfirmSubmission = elevate(submissions.confirmSubmission);
12    const submission = await elevatedConfirmSubmission(submissionId);
13    console.log('Success! Confirmed submission:', submission);
14    return submission;
15  } catch (error) {
16    console.error(error);
17    // Handle the error
18  }
19});
20
21/* Promise resolves to:
22{
23    "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
24    "namespace": "wix.form_app.form",
25    "status": "CONFIRMED",
26    "submissions": {
27        "last_name": "McBride",
28        "first_name": "Patsy"
29    },
30    "revision": "4",
31    "submitter": {
32        "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
33    },
34    "seen": true,
35    "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
36    "_createdDate": "2023-12-28T12:55:55.630Z",
37    "_updatedDate": "2023-12-28T13:42:24.853Z"
38}
39
40*/
41