---
title: "Update a list"
method: PATCH
path: "/lists/{id}"
tags: ["Lists"]
---

# Update a list

`PATCH /lists/{id}`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/lists/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

Rename, change purpose, turn monitoring or alert channels on or off, share with your team, archive (`archived: true`) or restore (`archived: false`).

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string
  - `purpose` 'clients' | 'suppliers' | 'portfolio' | 'prospects' | 'other'
  - `description` string, nullable
  - `monitor` boolean
  - `alert_email` boolean
  - `alert_webhook` boolean
  - `webhook_url` string, nullable
  - `shared_with_team` boolean
  - `archived` boolean: true archives the list, false restores it

## Response `200`

Updated

## Other responses

- `400`: Invalid input; `error` says what to change
- `401`: API key missing, malformed or revoked
- `403`: Plan limit or feature not included
- `404`: List not found (or private to the person who made it)
- `409`: Name taken, or the default list cannot be archived
- `429`: Per-minute or per-day limit reached (`code: rate_limited`, `window: minute|day`). Wait `Retry-After` seconds; when both windows are full the day is reported. A refused request does not count against either limit. A bulk lookup (`POST /company/bulk`) counts each company number in it as one request, so one that is more than you have left is refused whole, and the body adds `requested` and `fits`.

---

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