Overwrite Customer
helpscout.overwrite_customer
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Replace a customer's scalar fields wholesale; every field left blank here is cleared on the customer.
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
10 fields, 1 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 |
|---|---|---|---|---|---|
customer_id The numeric id of the customer to overwrite. | string | Yes | — | — | — |
first_name The customer's first name. | string | No | — | — | Ada |
last_name The customer's last name. | string | No | — | — | — |
phone The customer's phone number. | 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 | — | — | — |
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 |
|---|---|---|
updated True once Help Scout applied the overwrite. | boolean | — |
moved True when the conversation had been merged into another one and Help Scout answered a redirect instead of applying the write. | boolean | — |
status The HTTP status Help Scout answered with. | number | — |
location Where the merged conversation now lives, when moved is true. | string | — |
customer_id The customer that was acted on. | string | — |
fields_sent Which customer fields the overwrite carried. | array | — |
{
"customer_id": "",
"fields_sent": [],
"location": "",
"moved": false,
"status": 0,
"updated": false
}Notes
- Help Scout treats an omitted field as null, so this clears anything you do not send; use Update Customer for a partial change.
See Overwrite 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.