Update Customer
helpscout.update_customer
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Change parts of a customer with a JSON-Patch array, leaving every field the patch does not mention alone.
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
2 fields, 2 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 change. | string | Yes | — | — | — |
operations A JSON array of {"op": "replace", "path": "/firstName", "value": "Ada"} objects. | array | Yes | — | ≥ 1 characters; array of object | [{"op":"replace","path":"/firstName","value":"Ada"}] |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"operations": [
{
"op": "replace",
"path": "/firstName",
"value": "Ada"
}
]
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
updated True once Help Scout applied the patch. | 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 | — |
operation_count How many patch operations were sent. | number | — |
{
"customer_id": "",
"location": "",
"moved": false,
"operation_count": 0,
"status": 0,
"updated": false
}See Update 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.