Update Conversation
helpscout.update_conversation
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Apply one JSON-Patch operation to a conversation to change its subject, status, inbox, assignee or primary 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
4 fields, 3 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 |
|---|---|---|---|---|---|
conversation_id The numeric id of the conversation to act on. | string | Yes | — | — | — |
op The JSON-Patch operation to apply; use remove on /assignTo to un-assign the conversation. | string | No | replace | one of "add", "move", "remove", "replace" | — |
path Which part of the conversation the operation changes. | string | Yes | — | one of "/subject", "/primaryCustomer.id", "/draft", "/mailboxId", "/status", "/assignTo" | — |
value The new value; the numeric paths are sent to Help Scout as numbers. Not sent for op remove. | string | Yes | — | — | Order #1234 — shipping question |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"op": "replace",
"value": "Order #1234 — shipping question"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
updated True once Help Scout applied the change. | 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 | — |
conversation_id The conversation that was acted on. | string | — |
op The operation that was sent. | string | — |
path The path that was changed. | string | — |
{
"conversation_id": "",
"location": "",
"moved": false,
"op": "",
"path": "",
"status": 0,
"updated": false
}See Update Conversation 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.