---
title: "Edit a company on a list"
method: PATCH
path: "/lists/{id}/items/{number}"
tags: ["Lists"]
---

# Edit a company on a list

`PATCH /lists/{id}/items/{number}`

## Request

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

Change what you hold about a company on a list: your `note`, `tags`, your own reference (`custom_ref`) and whether its alerts are emailed (`notify_email`). Send only the fields to change.

## Path parameters

- `id` integer, required
- `number` string, required

## Request body

- object
  - `note` string, nullable
  - `tags` string[]
  - `custom_ref` string, nullable
  - `notify_email` boolean

## Response `200`

Updated

## Other responses

- `401`: API key missing, malformed or revoked
- `403`: The key's plan does not include this endpoint (`code: plan_upgrade_required`, with `upgrade_url`), the key may not call it, or the key is beyond the plan's key limit after a downgrade (`code: key_limit_exceeded`: the newest keys are paused until keys are deleted or the plan upgraded)
- `404`: Not on the list
- `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)
