---
title: "Put Driver Lease"
method: PUT
path: "/dialer/sessions/driver-lease"
tags: ["Dialer"]
---

# Put Driver Lease

`PUT /dialer/sessions/driver-lease`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/dialer/sessions/driver-lease`
- Auth: HTTP bearer

CONTACTS NOBODY. Grant, refresh or take over YOUR dialer driver lease.

Only one client at a time may drive a user's dialer. Call this on a timer from the
client that is driving; `takeover: true` moves the lease from another client of the
SAME user. Personal key only: the lease belongs to the key's own user.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- DriverLeaseRequest: Take, refresh or take over the per-user dialer driver lease ("one driver per user").
  - `client_id` string, required: Stable id of THIS client (a browser tab, the desktop app, your own app).
  - `surface` 'desktop' | 'web', required: Which kind of client holds the lease.
  - `session_id` string, nullable: The dialer session this client is driving, echoed back to other clients as the holder.
  - `takeover` boolean: Take the lease from the current holder instead of being refused.

## Response `200`

Successful Response

- ApiResponseDialerPayload
  - `data` DialerPayload, required: An open envelope for one dialer result. Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)