Deactivate Agent
freshservice.deactivate_agent
ActionBusiness appsconnection required
Calls the Freshservice API with the connection's credentials.
Deactivate a Freshservice agent and free the seat they occupied.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Freshservice
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- domain, workspace_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 |
|---|---|---|---|---|---|
agent_id The Freshservice agent to act on, by their numeric user id. | string | Yes | — | — | 1434 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"agent_id": "1434"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deactivated True once Freshservice deactivated the agent. | boolean | — |
deleted Always false: Freshservice deactivates rather than removing the agent. | boolean | — |
agent_id The agent that was deactivated. | string | — |
agent The agent record Freshservice returned, with active false. | object | — |
{
"agent": {},
"agent_id": "",
"deactivated": false,
"deleted": false
}Notes
- Freshservice's DELETE on an agent is a deactivation, not a removal; the separate forget operation is the destructive one and is deliberately not exposed here.
See Deactivate Agent run in a workflow.
In a technical demo we add the Freshservice connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.