bulkDeleteContacts( )

Deletes multiple contacts.

All contacts that meet the specified filter and search criteria are deleted. The request should contain a filter value or a search value, or both. To perform a dry run, call Query Contacts with the intended filter options.

When this method is called, a bulk job is started and the job ID is returned. The job might not complete right away, depending on its size. The job's status can be retrieved with Get Bulk Job.

The following errors might occur during the bulk processing and will appear in the bulk job:

  • CANNOT_DELETE_SITE_MEMBERS - Contact is a site member and can't be deleted. Member must be deleted first.
  • CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION - Contact has a valid billing subscription and can't be deleted.
  • CANNOT_DELETE_MEMBER_OWNER_OR_CONTRIBUTOR - Member is a Wix user and can't be deleted. This can happen only if the request indicated to delete the member.
  • FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION - Member was deleted, but contact was not. This can happen only if the request indicated to delete the member.
  • FAILED_DELETE_CONTACT - Contact could not be deleted.
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Members and Contacts - all permissions
Manage Contacts
Manage Stores
Manage Members
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkDeleteContactsOptions

Bulk delete contacts options.

Returns
Return Type:Promise<BulkDeleteContactsResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?