---
title: "Toggle Heartbeat Task"
method: PATCH
path: "/api/agents/{agent_id}/heartbeat-tasks/{task_id}"
tags: ["agents"]
---

# Toggle Heartbeat Task

`PATCH /api/agents/{agent_id}/heartbeat-tasks/{task_id}`

## Request

- Base URL: `https://api.tintin-x.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tintin-x.com/api/agents/{agent_id}/heartbeat-tasks/{task_id}`
- Auth: HTTP bearer

Toggle a heartbeat task on/off.

## Path parameters

- `agent_id` string, uuid, required
- `task_id` string, required

## Query parameters

- `skip_refresh` boolean: Skip workspace refresh (agent-side calls)

## Request body

- HeartbeatTaskToggleRequest: Toggle a heartbeat task on/off.
  - `enabled` boolean, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tintin-x/apis/tintin-api.md) · [All operations](https://skmtc.dev/tintin-x/apis/tintin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tintin-x/apis/tintin-api/revisions/8839a8d0a66c?raw)