Set Conversation Custom Fields
helpscout.update_conversation_custom_fields
ActionBusiness appsconnection required
Calls the Help Scout API with the connection's credentials.
Replace a conversation's custom-field values with exactly the list given; any user-created field left out is cleared.
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 |
|---|---|---|---|---|---|
conversation_id The numeric id of the conversation to act on. | string | Yes | — | — | — |
fields The complete custom-field list as a JSON array of {"id": 1, "value": "…"} objects. | array | Yes | — | array of object | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
updated True once Help Scout applied the custom-field 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 | — |
field_count How many custom fields were sent. | number | — |
{
"conversation_id": "",
"field_count": 0,
"location": "",
"moved": false,
"status": 0,
"updated": false
}See Set Conversation Custom Fields 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.