---
title: "Update an existing list"
method: PATCH
path: "/api/v2/lists/{id}"
tags: ["Lists"]
---

# Update an existing list

`PATCH /api/v2/lists/{id}`

## Request

- Base URL: `https://yournation.nationbuilder.com`
- URL: `https://yournation.nationbuilder.com/api/v2/lists/{id}`
- Auth: HTTP bearer

Updates an existing list

## Request body

- ListUpdateRequest: The JSON:API top-level document shape for update requests, whose data member identifies the resource by type and id and carries the changed attributes.
  - `data` object, required
    - `id` string, required: The ID of the resource being updated.
    - `type` 'lists', required: The JSON:API resource type of the resource being updated.
    - `attributes` ListReadWriteAttributes: The attributes of a list that can be both read and written.
      - `author_id` string, nullable: The ID of the list's author.
      - `description` string, nullable: Describes what the list is for.
      - `is_sharing_writable` boolean, nullable: Gives edit permission to people who the list is shared.
      - `name` string, nullable: The name of the custom list.
      - `parent_id` string, nullable: The id of the original list this was split off from.
      - `signup_id` string, nullable: The person who this list is assigned to, not the author.
      - `slug` string, nullable: A unique identifier for the list. Not required for groups.

## Response `200`

The updated list.

- ListShowResponse: The JSON:API top-level document shape for responses returning a single resource under the data member.
  - `data` object, required: A JSON:API resource identifier object, the type/id pair that uniquely identifies a single resource.
    - `id` string, required: Unique identifier of the resource.
    - `type` 'lists', required: The JSON:API resource type.
    - `attributes` object: The read-only attributes of a list.
      - `author_id` string, nullable: The ID of the list's author.
      - `description` string, nullable: Describes what the list is for.
      - `is_sharing_writable` boolean, nullable: Gives edit permission to people who the list is shared.
      - `name` string, nullable: The name of the custom list.
      - `parent_id` string, nullable: The id of the original list this was split off from.
      - `signup_id` string, nullable: The person who this list is assigned to, not the author.
      - `slug` string, nullable: A unique identifier for the list. Not required for groups.
      - `created_at` string, date-time, nullable: When the list was created.
      - `signups_count` integer, nullable: The number of signups on the list.
      - `updated_at` string, date-time, nullable: The last time the list was updated.
  - `included` Resource[]: Sideloaded resources requested via the include query parameter. Each entry is a full resource object whose shape is documented under its own resource type.
    - `id` string, required: Unique identifier of the resource.
    - `type` string, required: The JSON:API resource type.
    - `attributes` object: The attributes of the resource, as documented for its resource type.
    - `relationships` object: References from this resource to other resources in the document.
  - `meta` object: Non-standard information about the document. Empty unless the endpoint has metadata to convey.

## Other responses

- `400`: The request body or query parameters are invalid, such as an unknown attribute, filter, filter operator, sort field, or sideload.
- `401`: The access token is missing, expired, or not authorized to access this resource.
- `404`: No resource exists with the provided ID.
- `422`: Model validations failed for the resource being created or updated. Unlike this API's other errors, validation failures are returned as a JSON:API errors document locating each invalid field.
- `429`: The access token has exceeded its request quota for the current rate-limit window.

## Changes

- **2026-11-05** `d5c88ca497ac`: 4 breaking, 1 warning, 8 info
  - added `#/components/schemas/update_request_document, subschema #2` to the request body `allOf` list
  - the request's body type changed from `object` to no type
  - the response's body type changed from `object` to no type for status `200`
  - removed the required property `data` from the response with the `200` status
  - …9 more

[Operation history](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/changes/api/v2/lists/:id/patch.md)

---

[API](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api.md) - [All operations](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/revisions/d5c88ca497ac?raw)