View as Markdown
Square icon

Square ACTION

Create Customer

Creates a new customer for a business. Must provide at least one of the following: Given Name, Family Name, Company Name, Email Address, or Phone Number. See the docs.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Square account once, then configure and run Create Customer from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "square-create-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    square: { authProvisionId: "apn_xxxxxxx" },
    givenName: "Given Name",
    familyName: "Family Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Customer inputs
Property Type Description
givenName Given Name string
The first name associated with the customer profile
Optional
familyName Family Name string
The last name associated with the customer profile
Optional
companyName Company Name string
A business name associated with the customer profile
Optional
email Email Address string
The email address associated with the customer profile
Optional
phoneNumber Phone Number string
Must be a valid phone number and can contain 9-16 digits, with an optional + prefix and country code
Optional
referenceId Reference ID string
An optional second ID used to associate the customer profile with an entity in another system
Optional
note Note string
A custom note associated with the customer profile
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
square-create-customer
Version
0.0.5
App
Square
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes