Check the customer merge password

When to use this endpoint

Use Customers_mergeCheckPass as the CRM UI preflight before showing or submitting a customer merge workflow.

The endpoint does not identify merge source/target customers, perform a merge, or issue an authorization token.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler performs no page, edit, or administrator-permission check.

The comparison uses the authenticated tenant’s customer-merge-password setting, which the settings endpoint stores as a salted MD5 digest.

Parameters

Parameter	Type	Required	Description
`password`	String	No	Value to compare. Omission is treated as an empty string.

Example request

$check = FM_api('Customers_mergeCheckPass', [
	'password' => 'replace-with-entered-merge-password',
]);

Example response

{
  "ok": 1
}

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error":"Incorrect password"}`	The supplied/default-empty value does not match, including when no merge password has been configured. Capitalization is part of this legacy response.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

This does not authorize the mutation endpoint. Customers_merge does not consume a token from this check and does not independently verify the merge password. This endpoint is a client-side workflow gate only.

A success result contains no expiry, scope, source customer, or target customer.
The endpoint is read-only. It does not rate-limit attempts, record an approval, or modify the password setting.
There is no pagination or object filter.

See it in Fieldmotion

CRM1

On Customers, choose the bulk or page-level merge action, or open a customer and choose Merge. Submitting the password dialog calls Customers_mergeCheckPass before CRM1 calls the separate merge endpoint.

CRM2

On Customers or a Customer edit page, begin a merge and submit the password dialog. Filter Network requests for Customers_mergeCheckPass before the merge request.

Related endpoints

Customers_exportCheckPass checks the separate export password.
Customers_getById can load candidate customer records before a merge selection.