---
title: "Rename a list"
method: PATCH
path: "/api/v1/lists/{list_id}"
tags: ["Lists"]
---

# Rename a list

`PATCH /api/v1/lists/{list_id}`

## Request

- Base URL: `https://app.argorant.com`
- URL: `https://app.argorant.com/api/v1/lists/{list_id}`
- Auth: HTTP bearer

Give a list a new name.

| Cost | What it does | Key scopes |
| --- | --- | --- |
| Free | Writes | `argorant:manage_lists` |

## Path parameters

- `list_id` integer, required

## Headers

- `Idempotency-Key` string
- `X-Request-Id` string

## Request body

- object
  - `name` string, required: The new name.

## Response `200`

OK

- SavedList
  - `list_id` integer: List id.
  - `name` string: List name.
  - `record_type` 'person' | 'company': What the list holds.
  - `selection_mode` 'filtered' | 'records': filtered: a saved search that follows its filters. records: the people you picked.
  - `filters` object: The search filters of a saved search.
  - `snapshot_total` integer: How many matched when the list was saved.
  - `item_count` integer: People stored in the list.
  - `created_at` string, date-time, nullable: When it was created.
  - `updated_at` string, date-time, nullable: When it last changed.

## Other responses

- `401`: 401 Unauthorized. `unauthorized` when the API key is missing, wrong or revoked.
- `403`: 403 Forbidden. `scope_missing` when the key lacks argorant:manage_lists.
- `404`: 404 Not found. `not_found` when the item does not exist in your workspace.
- `409`: 409 Conflict. `idempotency_conflict` when the Idempotency-Key was used with another body.
- `422`: 422 Validation error. `validation_error` when a field has the wrong type or is missing.
- `429`: 429 Too many requests. `rate_limited` when too many requests this minute.

---

[API](https://skmtc.dev/argorant/apis/argorant-api.md) · [All operations](https://skmtc.dev/argorant/apis/argorant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/argorant/apis/argorant-api/revisions/4bc28c0085b6?raw)