---
title: "Update an email list"
method: PATCH
path: "/v1/email-lists/{id}"
tags: ["Email lists"]
---

# Update an email list

`PATCH /v1/email-lists/{id}`

## Request

- Base URL: `https://api.upcheck.so`
- URL: `https://api.upcheck.so/v1/email-lists/{id}`
- Auth: HTTP bearer

`emails` replaces the whole set when sent.

## Path parameters

- `id` string, required

## Request body

- object: Fields to change. Omitted fields are left as they are.
  - `name` string
  - `emails` string[]

## Response `200`

The updated list.

- object
  - `id` string, required: Opaque identifier.
  - `organizationId` string, required: Opaque identifier.
  - `name` string, required
  - `emails` string[], required
  - `createdAt` number, required

## Other responses

- `400`: The request body or parameters are invalid. `error` names the first problem.
- `401`: The API key is missing, invalid, or revoked.
- `403`: The key's role does not allow this action.
- `404`: No such resource in this organization.
- `429`: The key's rate limit was exceeded. Honour `Retry-After`.

---

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