Delete Customer
helpscout.delete_customer
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Hard-delete a customer together with their conversations and survey responses; there is no undo.
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
1 field, 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 delete. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deleted True once Help Scout applied the deletion. | 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 | — |
{
"customer_id": "",
"deleted": false,
"location": "",
"moved": false,
"status": 0
}Notes
- Help Scout refuses with 403 when the credential cannot see every one of the customer's conversations, or when they have more than 100.
See Delete 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.