View as Markdown
Help Scout icon

Help Scout ACTION

Create Customer

Creates a new customer record in Help Scout. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Help Scout 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: "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)

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
firstName First Name string
First name of the customer. When defined it must be between 1 and 40 characters.
Optional
lastName Last Name string
Last name of the customer. When defined it must be between 1 and 40 characters.
Optional
phone Phone string
The phone number that will be used when creating a new customer.
Optional
photoUrl Photo URL string
URL of the customer's photo. Max length 200 characters.
Optional
jobTitle Job Title string
Job title. Max length 60 characters.
Optional
photoType Photo Type string
The type of photo.
Optional
background Background string
This is the Notes field from the user interface. Max length 200 characters.
Optional
location Location string
Location of the customer. Max length 60 characters.
Optional
organization Organization string
Organization. Max length 60 characters.
Optional
gender Gender string
Gender of this customer.
Optional
age Age string
Customer's age.
Optional
emails Emails string[]
List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation.
Optional
phones Phones string[]
List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation.
Optional
chats Chats string[]
List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation.
Optional
socialProfiles Social Profiles string[]
List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.
Optional
websites Websites string[]
List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation.
Optional
addressCity Address City string
The city of the customer.
Optional
addressState Address State string
The state of the customer.
Optional
addressPostalCode Address Postal Code string
The postal code of the customer.
Optional
addressCountry Address Country string
The ISO 3166 Alpha-2 code country of the customer.
Optional
addressLines Address Lines string[]
A list of address lines.
Optional
properties Properties string[]
List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.
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
help_scout-create-customer
Version
0.0.5
App
Help Scout
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes