# Defer a heartbeat item

Put one pending heartbeat suggestion off until a moment, so it leaves the queue and the record strip until then. The item stays planned - nobody has decided anything - it is simply not due. Send {"until": "2026-09-14"} or an RFC3339 timestamp; send nothing to snooze by the workspace's default. Refuses a moment in the past, one past the workspace's defer limit, and any item already settled.

Access class: `workspace:admin`.

## Endpoint

`POST /v1/workspace/heartbeat/actions/{id}/defer`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| id | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "body": {
    "until": "string"
  },
  "params": {
    ":id": "string"
  },
  "query": {}
}
```

## Responses

### 201

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "conversation_id": 1,
    "created_at": "string",
    "deferred_at": "string",
    "deferred_by_user_id": 1,
    "deferred_until": "string",
    "id": 1,
    "kind": "string",
    "payload": "string",
    "plan_index": 1,
    "reason": "string",
    "record_id": 1,
    "reverted_at": "string",
    "reverted_by_user_id": 1,
    "reverted_from": "string",
    "reviewed_at": "string",
    "reviewed_by_user_id": 1,
    "run_id": 1,
    "settled_at": "string",
    "state": "string"
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```