Skip to main content

actions/attachCustomerInformation

Actions​

AttachCustomerInformationFn()​

AttachCustomerInformationFn: (params) => Promise\<void>

Attach additional information to a customer

Parameters​

• params: AttachCustomerInformationParams

The parameters required to attach the information

Returns​

Promise\<void>

Example​

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

const compilotSdk = createSdk({ apiKey });

await compilotSdk.attachCustomerInformation({
 externalCustomerId: "123",
 information: {
   email: "test@test.com",
   phone: "+1234567890",
   wallet: {
     address: "tz1abc",
     namespace: "tezos",
   },
 }
});

Other​

AttachCustomerInformationParams​

AttachCustomerInformationParams: {externalCustomerId: string;information: AdditionalCustomerInformationParams; }

Attach additional information to a customer

Type declaration​

externalCustomerId​

externalCustomerId: string

The customer ID from the perspective of your system

information​

information: AdditionalCustomerInformationParams

The additional information to attach

AttachCustomerInformationParams​

AttachCustomerInformationParams: ZodType\<AttachCustomerInformationParams, ZodTypeDef, AttachCustomerInformationParams>