---
title: "Heartbeat"
method: PATCH
path: "/v1/matters/{matter_id}/editing/{kind}/{document_id}/lease"
tags: ["editing"]
---

# Heartbeat

`PATCH /v1/matters/{matter_id}/editing/{kind}/{document_id}/lease`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/editing/{kind}/{document_id}/lease`
- Auth: HTTP bearer

## Path parameters

- `document_id` string, uuid, required
- `kind` string, required
- `matter_id` string, uuid, required

## Request body

- LeaseClient
  - `client_id` string, uuid, required

## Response `200`

Successful Response

- AppModulesEditingSchemasLeaseStatus: Who may edit the document now. ``editable`` is true only for the client holding the lease. ``held_by_you`` is also true when the actor holds it from another client.
  - `document_id` string, uuid, required
  - `editable` boolean, required
  - `held_by_you` boolean, required
  - `owner_name` string, required
  - `expires_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)