Delete Conversation

helpscout.delete_conversation
ActionBusiness appsconnection required

Calls the Help Scout API with the connection's credentials.

Delete a conversation from Help Scout; this cannot be undone.

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.

FieldTypeRequiredDefaultConstraintsExample
conversation_id
The numeric id of the conversation to act on.
stringYes———

Output

One shape.

result

FieldTypeExample
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—
conversation_id
The conversation that was acted on.
string—
{
  "conversation_id": "",
  "deleted": false,
  "location": "",
  "moved": false,
  "status": 0
}

See Delete 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.