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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "square-create-customer",
"configured_props": {
"square": { "authProvisionId": "apn_xxxxxxx" },
"givenName": "Given Name",
"familyName": "Family Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "square",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "square-create-customer",
arguments: {
givenName: "Given Name",
familyName: "Family Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗