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

# Update a contact list

`PATCH /v1/lists/{id}`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/lists/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `lists:m`.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string

## Response `200`

The updated list.

- ContactList: An allow/deny contact list with every entry embedded. Assign it to an API key to restrict who that key may message.
  - `id` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `entry_count` integer, required
  - `entries` object[], required
    - `id` string, required
    - `phone_number` string, nullable, required: Set on a direct number entry.
    - `contact_id` string, nullable, required: Set on a contact entry.
    - `contact_group_id` string, nullable, required: Set on a group entry, which expands to the group's members at send time.
    - `contact_name` string, nullable, required
    - `contact_phone` string, nullable, required
    - `group_name` string, nullable, required
    - `added_at` string, date-time, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: LIVE_KEY_REQUIRED when a test key tries to change something a live key's allow/deny list references. Also FORBIDDEN when the key lacks the permission.
- `404`: CONTACT_LIST_NOT_FOUND.
- `409`: CONTACT_LIST_ALREADY_EXISTS: the name is taken.
- `422`: VALIDATION_ERROR: the request failed validation; details names the fields.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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