# Create Customer — Help Scout

> Creates a new customer record in Help Scout. See the documentation

- Key: `help_scout-create-customer`
- Type: Action (Write)
- Version: 0.0.5
- App: Help Scout (`help_scout`) — https://pipedream.com/apps/help-scout.md
- This page (HTML): https://pipedream.com/apps/help-scout/actions/create-customer
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/help_scout/actions/create-customer/create-customer.mjs

## Description

Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `firstName` | `string` | No | First name of the customer. When defined it must be between 1 and 40 characters. |
| `lastName` | `string` | No | Last name of the customer. When defined it must be between 1 and 40 characters. |
| `phone` | `string` | No | The phone number that will be used when creating a new customer. |
| `photoUrl` | `string` | No | URL of the customer's photo. Max length 200 characters. |
| `jobTitle` | `string` | No | Job title. Max length 60 characters. |
| `photoType` | `string` | No | The type of photo. |
| `background` | `string` | No | This is the Notes field from the user interface. Max length 200 characters. |
| `location` | `string` | No | Location of the customer. Max length 60 characters. |
| `organization` | `string` | No | Organization. Max length 60 characters. |
| `gender` | `string` | No | Gender of this customer. |
| `age` | `string` | No | Customer's age. |
| `emails` | `string[]` | No | List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation. |
| `phones` | `string[]` | No | List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation. |
| `chats` | `string[]` | No | List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation. |
| `socialProfiles` | `string[]` | No | List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation. |
| `websites` | `string[]` | No | List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation. |
| `addressCity` | `string` | No | The city of the customer. |
| `addressState` | `string` | No | The state of the customer. |
| `addressPostalCode` | `string` | No | The postal code of the customer. |
| `addressCountry` | `string` | No | The ISO 3166 Alpha-2 code country of the customer. |
| `addressLines` | `string[]` | No | A list of address lines. |
| `properties` | `string[]` | No | List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "help_scout",
      },
    },
  },
)

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: "help_scout-create-customer",
  arguments: {
    firstName: "First Name",
    lastName: "Last Name",
  },
})
```

**TypeScript**

```ts
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: "help_scout-create-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    help_scout: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

console.log(result)
```

**cURL**

```bash
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": "help_scout-create-customer",
    "configured_props": {
      "help_scout": { "authProvisionId": "apn_xxxxxxx" },
      "firstName": "First Name",
      "lastName": "Last Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/help-scout.md · All apps: https://pipedream.com/apps