Check the customer export password

When to use this endpoint

Use Customers_exportCheckPass as the CRM user-interface preflight before opening the customer or contract export workflow.

This call does not export data, create a grant, or issue a token. A successful response merely means the value matched at the instant of this request.

Authentication and permissions

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

The comparison uses the customer-export-password setting from the authenticated tenant. The settings UI stores a salted MD5 digest rather than the clear-text value.

Parameters

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

Example request

$check = FM_api('Customers_exportCheckPass', [
	'password' => 'replace-with-entered-export-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 or default-empty value does not match the stored digest, including when the setting has never been configured.

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 is a UI preflight, not export authorization. Customers_getExportData does not call this password check and does not verify a password itself. Do not treat {"ok":1} as a reusable capability.

The response does not reveal whether the setting is absent versus configured to a different password.
The endpoint is read-only. It does not rate-limit attempts, change the setting, or record an export.
There is no pagination or object filter.

See it in Fieldmotion

CRM1

Open Customers or Contracts and choose Export. The password dialog calls Customers_exportCheckPass before it opens the export field mapper.

CRM2

Open Customers or Contracts and choose Export. Filter Network requests for Customers_exportCheckPass when submitting the export-password dialog.

Related endpoints

Customers_getExportData performs the two-stage customer export read.
Customers_mergeCheckPass checks the separate merge password and uses different error capitalization.