> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # CancelIntakeFormSubmission # Package: intakeForms # Namespace: IntakeFormSubmissionsService # Method link: https://dev.wix.com/docs/api-reference/crm/forms/other-services/intake-forms/intake-form-submissions/cancel-intake-form-submission.md ## Permission Scopes: Manage Intake Form (PII): SCOPE.INTAKE-FORM.MANAGE_LIMITED ## Introduction Changes an intake form submission's status to `CANCELED`. The submission remains in the system for record-keeping, but is no longer valid. You can't reactivate it, the contact must create a new submission to have a valid submission again. --- ## REST API ### Schema ``` Method: cancelIntakeFormSubmission Description: Changes an intake form submission's status to `CANCELED`. The submission remains in the system for record-keeping, but is no longer valid. You can't reactivate it, the contact must create a new submission to have a valid submission again. URL: https://www.wixapis.com/intake-forms/v1/intake-form-submissions/{intakeFormSubmissionId}/cancel Method: POST Return type: CancelIntakeFormSubmissionResponse - name: intakeFormSubmission | type: IntakeFormSubmission | description: Canceled intake form submission. - name: id | type: string | description: Intake form submission GUID. Identical to the [Wix Forms form submission GUID](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-object.md). - name: createdDate | type: string | description: Date and time the intake form submission was created in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. - name: revision | type: string | description: Revision number, which increments by 1 each time the intake form submission is updated. To prevent conflicting changes, you must specify the current revision when updating the intake form submission. - name: signer | type: Signer | description: Information about the person who submitted the intake form. - name: contactId | type: string | description: [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction.md) GUID. - name: fullName | type: string | description: Contact's full name. - name: email | type: string | description: Contact's email address. - name: submitter | type: Submitter | description: Whether the form was submitted by the customer directly or by the business on the customer's behalf. - enum: - CUSTOMER: Customer submitted the form themselves. - BUSINESS: Business owner or staff submitted the form on behalf of the customer. - name: status | type: Status | description: Submission status. - enum: - VALID: Submission is valid and hasn't expired. - EXPIRED: Submission has expired. The business must extend the submission or the contact must resubmit the form. - CANCELED: Submission was canceled. The contact must resubmit the form. - EXTENDED: The business has manually extended the submission's validity. - EXEMPT: The business has manually exempted the customer from submitting the form. - name: expirationDate | type: string | description: Date and time when the submission expires in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Calculated from `createdDate` plus the intake form's `expirationPeriodInMonths`. You can manually extend the expiration date. - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned only when `INTAKE_FORM_INFO` is requested in the `fields` parameter. - name: id | type: string | description: Intake form GUID. - name: name | type: string | description: Intake form name. - name: expirationPeriodInMonths | type: integer | description: Expiration period in months for the intake form. - name: archived | type: boolean | description: Whether the intake form is archived. - name: updatedDate | type: string | description: Date and time the submission status was manually updated (canceled or extended) in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. ``` ### Examples ### Cancel intake form submission ```curl curl -X POST \ 'https://www.wixapis.com/intake-form-submissions/v1/intake-form-submissions/880e8400-e29b-41d4-a716-446655440003/cancel' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.intakeForms.IntakeFormSubmissionsService.cancelIntakeFormSubmission(intakeFormSubmissionId) Description: Changes an intake form submission's status to `CANCELED`. The submission remains in the system for record-keeping, but is no longer valid. You can't reactivate it, the contact must create a new submission to have a valid submission again. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: intakeFormSubmissionId Method parameters: param name: intakeFormSubmissionId | type: string | description: Intake form submission GUID. | required: true Return type: PROMISE - name: intakeFormSubmission | type: IntakeFormSubmission | description: Canceled intake form submission. - name: _id | type: string | description: Intake form submission GUID. Identical to the [Wix Forms form submission GUID](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-object.md). - name: _createdDate | type: Date | description: Date and time the intake form submission was created in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. - name: revision | type: string | description: Revision number, which increments by 1 each time the intake form submission is updated. To prevent conflicting changes, you must specify the current revision when updating the intake form submission. - name: signer | type: Signer | description: Information about the person who submitted the intake form. - name: contactId | type: string | description: [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction.md) GUID. - name: fullName | type: string | description: Contact's full name. - name: email | type: string | description: Contact's email address. - name: submitter | type: Submitter | description: Whether the form was submitted by the customer directly or by the business on the customer's behalf. - enum: - CUSTOMER: Customer submitted the form themselves. - BUSINESS: Business owner or staff submitted the form on behalf of the customer. - name: status | type: Status | description: Submission status. - enum: - VALID: Submission is valid and hasn't expired. - EXPIRED: Submission has expired. The business must extend the submission or the contact must resubmit the form. - CANCELED: Submission was canceled. The contact must resubmit the form. - EXTENDED: The business has manually extended the submission's validity. - EXEMPT: The business has manually exempted the customer from submitting the form. - name: expirationDate | type: Date | description: Date and time when the submission expires in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Calculated from `createdDate` plus the intake form's `expirationPeriodInMonths`. You can manually extend the expiration date. - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned only when `INTAKE_FORM_INFO` is requested in the `fields` parameter. - name: _id | type: string | description: Intake form GUID. - name: name | type: string | description: Intake form name. - name: expirationPeriodInMonths | type: integer | description: Expiration period in months for the intake form. - name: archived | type: boolean | description: Whether the intake form is archived. - name: _updatedDate | type: Date | description: Date and time the submission status was manually updated (canceled or extended) in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. ``` ### Examples ### cancelIntakeFormSubmission ```javascript import { intakeFormSubmissions } from '@wix/intake-forms'; async function cancelIntakeFormSubmission(intakeFormSubmissionId) { const response = await intakeFormSubmissions.cancelIntakeFormSubmission(intakeFormSubmissionId); }; ``` ### cancelIntakeFormSubmission (with elevated permissions) ```javascript import { intakeFormSubmissions } from '@wix/intake-forms'; import { auth } from '@wix/essentials'; async function myCancelIntakeFormSubmissionMethod(intakeFormSubmissionId) { const elevatedCancelIntakeFormSubmission = auth.elevate(intakeFormSubmissions.cancelIntakeFormSubmission); const response = await elevatedCancelIntakeFormSubmission(intakeFormSubmissionId); } ``` ### cancelIntakeFormSubmission (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { intakeFormSubmissions } from '@wix/intake-forms'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { intakeFormSubmissions }, // Include the auth strategy and host as relevant }); async function cancelIntakeFormSubmission(intakeFormSubmissionId) { const response = await myWixClient.intakeFormSubmissions.cancelIntakeFormSubmission(intakeFormSubmissionId); }; ``` ---