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

# Update a subscriber list

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

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/lists/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `lists:write`)

Partial update. Omitted fields are left alone, and `null` for `description`, `confirmation_template_id` or `redirect_url` is treated the same as omitting them — this surface cannot clear a field back to empty yet.

**`double_opt_in` does not make Sendly send anything.** With it on, `POST /api/lists/{id}/subscribe` creates the membership as `PENDING` and returns a `confirm_token`; delivering `/api/lists/confirm-subscription?token=<token>` to the contact is YOUR job. A list that turns the flag on without sending that link collects pending memberships and confirms none of them.

Turning `double_opt_in` on affects only memberships created afterwards. Existing `CONFIRMED` memberships stay confirmed: those contacts consented under the rule in force when they subscribed, and demoting them would revoke a consent record rather than collect one.

Requires the `lists:write` scope — Create, rename, and delete your subscriber lists.

## Path parameters

- `id` string, uuid, required: Resource id.

## Request body

- ListV1Update: Body for PATCH /api/v1/lists/{id}.
  - `confirmation_template_id` string, uuid, nullable
  - `description` string, nullable
  - `double_opt_in` boolean
  - `name` string
  - `redirect_url` string, uri, nullable

## Response `200`

The updated list

- ListV1: A subscriber list as exposed on the v1 API.
  - `confirmation_template_id` string, uuid, nullable, required
  - `created_at` string, date-time, required
  - `description` string, nullable, required
  - `double_opt_in` boolean, required
  - `id` string, uuid, required
  - `member_count` integer, required: Memberships in ANY status, including PENDING and UNSUBSCRIBED ones.
  - `name` string, required
  - `redirect_url` string, nullable, required
  - `updated_at` string, date-time, required

## Other responses

- `401`: `invalid_api_key` or `invalid_session` — missing or invalid credentials.
- `403`: `scope_missing`, `project_access_denied`, or `project_disabled`.
- `404`: `resource_not_found` — no list with this id belongs to the authenticated project.
- `422`: `validation_error` — query, path, or body parameters did not match the schema.
- `429`: `rate_limited` — see `Retry-After` and the `RateLimit` headers.
- `500`: `internal_error`.

---

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