Bulk Create Customers - Automate.ax

square.bulkCreateCustomers creates multiple customer profiles for a business.

Example

automations/square-bulk-create-customers.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Bulk Square Create Customers", () => {
  onDashboardRun({ title: "Bulk Square Create Customers" })

  square.bulkCreateCustomers({
    customers: {
      "8bb76c4f-e35d-4c5b-90de-1194cd9179f0": {
        givenName: "Amelia",
        familyName: "Earhart",
        emailAddress: "Amelia.Earhart@example.com",
        address: {
          addressLine1: "500 Electric Ave",
          addressLine2: "Suite 600",
          locality: "New York",
          administrativeDistrictLevel1: "NY",
          postalCode: "10003",
          country: "US",
        },
        phoneNumber: "+1-212-555-4240",
        referenceId: "YOUR_REFERENCE_ID",
        note: "a customer",
      },
      "d1689f23-b25d-4932-b2f0-aed00f5e2029": {
        givenName: "Marie",
        familyName: "Curie",
        emailAddress: "Marie.Curie@example.com",
        address: {
          addressLine1: "500 Electric Ave",
          addressLine2: "Suite 601",
          locality: "New York",
          administrativeDistrictLevel1: "NY",
          postalCode: "10003",
          country: "US",
        },
        phoneNumber: "+1-212-444-4240",
        referenceId: "YOUR_REFERENCE_ID",
        note: "another customer",
      },
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_WRITE.

Field	Type	Required	Default	Description
`customers`	`Record\<string, Square.BulkCreateCustomerData\>`	Yes	—	A map of 1 to 100 individual create requests, represented by `idempotency key: \{ customer data \}` key-value pairs. Each key is an idempotency key that uniquely identifies the create request. Each value contains the customer data used to create the customer profile.

Use the official BulkCreateCustomers reference for provider field semantics and limits.

Output

Returns the official Square.BulkCreateCustomersResponse response as a codec-safe object. Square integer money amounts remain bigint values.