previewMergeContacts( )

Previews merging source contacts into a target contact.

This method performs a dry run without deleting or updating any contacts. A preview of the updated target contact is returned, but no data is changed in the contact list.

To perform the actual merge, use Merge Contacts.

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
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
targetContactIdstringRequired

Target contact ID.

optionsPreviewMergeContactsOptions

Preview merge contacts options.

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

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

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

Did this help?