Skip to main content

actions/getCustomerStatusByExternalCustomerId

Actions​

GetCustomerStatusByExternalCustomerIdFn()​

GetCustomerStatusByExternalCustomerIdFn: (params) => Promise\<CustomerStatus | null>

Get the status of a customer by their external customer ID

Parameters​

• params

The parameters required to get the customer status

• params.externalCustomerId: ExternalCustomerId

Returns​

Promise\<CustomerStatus | null>

The status of the customer

Example​


import { createSdk } from "@compilot/js-sdk";

const compilotSdk = createSdk({ apiKey });

const customerStatus = await compilotSdk.getCustomerStatusByExternalCustomerId({
 externalCustomerId: "123",
});