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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Contacts
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?