---
title: "Update a list"
method: POST
path: "/v1/lists/{id}"
---

# Update a list

`POST /v1/lists/{id}`

Updates an existing list by ID. Only included fields are modified.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `lists:update`

**[Rate limit category](/using-the-api/rate-limits/):** Write

## Path parameters

- `id` string, required — Unique identifier of the list to update.

## Headers

- `Lightfield-Version` '2026-03-01', required

## Request body

- object
  - `fields` object — Field values to update — only provided fields are modified; omitted fields are left unchanged.
    - `$name` string — Display name of the list.
    - `$description` string, nullable — Optional description of what this list is for. Pass null to clear.
    - `$kind` 'target', nullable — Product-level list purpose. Normally leave unset; reserve `target` for the single account-prioritization (APG) demand list per org (account/contact lists only). Pass null to clear.
  - `relationships` object — Relationship operations. Use the key matching the list's `$objectType` (e.g. `$accounts` for an account list).
    - `$accounts` object — Add/remove accounts. List `$objectType` must be `account`.
      - `add` union — Entity ID(s) to add to the list.
        - string
        - string[]
      - `remove` union — Entity ID(s) to remove from the list.
        - string
        - string[]
    - `$contacts` object — Add/remove contacts. List `$objectType` must be `contact`.
      - `add` union — Entity ID(s) to add to the list.
        - string
        - string[]
      - `remove` union — Entity ID(s) to remove from the list.
        - string
        - string[]
    - `$opportunities` object — Add/remove opportunities. List `$objectType` must be `opportunity`.
      - `add` union — Entity ID(s) to add to the list.
        - string
        - string[]
      - `remove` union — Entity ID(s) to remove from the list.
        - string
        - string[]

## Response `200`

OK

- ListUpdateResponse
  - `id` string, required — Unique identifier for the list.
  - `createdAt` string, required — ISO 8601 timestamp of when the list was created.
  - `httpLink` string, nullable, required — URL to view the list in the Lightfield web app, or null.
  - `fields` object, required — Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`).

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `415` — 415
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503
- `504` — 504

---

[API](https://skmtc.net/lightfld/apis/api-reference.md) · [All operations](https://skmtc.net/lightfld/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightfld/api-reference/versions/93b6c5de5463/schema)