Create Customer
helpscout.create_customer
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Create a customer record, with any email addresses and phones it has.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Help Scout
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- mailbox_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
12 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
first_name The customer's first name. | string | No | — | — | Ada |
last_name The customer's last name. | string | No | — | — | — |
phone A phone number to store on the new customer. | string | No | — | — | — |
job_title The customer's job title. | string | No | — | — | — |
location Where the customer is. | string | No | — | — | — |
background The notes field Help Scout shows beside the customer. | string | No | — | — | — |
organization_id The numeric id of the Help Scout organization the customer belongs to. | string | No | — | — | — |
gender The gender recorded on the customer. | string | No | — | one of "male", "female", "unknown" | — |
age The age band recorded on the customer. | string | No | — | — | — |
emails Email addresses as a JSON array of {"type": "work", "value": "a@b.com"} objects. | array | No | — | array of object | — |
phones Phone numbers as a JSON array of {"type": "work", "value": "555…"} objects. | array | No | — | array of object | — |
address The postal address as a JSON object with city, state, postalCode, country and lines. | object | No | — | — | — |
- At least one of first_name, emails, last_name, phone, phones, job_title, location, background, organization_id, gender, age, address must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"first_name": "Ada"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
created True once Help Scout answered 201 Created. | boolean | — |
kind Which resource was created: conversation, thread, customer or email. | string | — |
id The new resource's id, read from the Resource-ID response header. | string | — |
location The API URL of the new resource, from the Location header. | string | — |
web_location The Help Scout web URL of the new resource, when sent. | string | — |
status The HTTP status Help Scout answered with. | number | — |
{
"created": false,
"id": "",
"kind": "",
"location": "",
"status": 0,
"web_location": ""
}See Create Customer run in a workflow.
In a technical demo we add the Help Scout connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.