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

# Update email list

`PATCH /v1/email_lists/{id}`

## Request

- Base URL: `https://contacts-api.paymongo.com`
- URL: `https://contacts-api.paymongo.com/v1/email_lists/{id}`
- Auth: HTTP bearer

Change an email list's description, metadata or merchant_visibility. purpose and organization_id can't be changed. Internal callers only. Requires an S2S token with an admin_id claim, recorded in created_by and updated_by; without one, 401.

## Path parameters

- `id` string, required

## Request body

- UpdateEmailListRequestDTO
  - `description` string
  - `merchant_visibility` 'hidden' | 'read_only' | 'editable'
  - `metadata` object

## Response `200`

OK

- object: Standard response containing data and its metadata if any
  - `data` EmailListResponseDTO
    - `attributes` EmailListAttributesDTO
      - `created_at` string
      - `created_by` string
      - `description` string
      - `entries` EntryDTO[]
        - `email` string
        - `name` string
      - `max_entries` integer: MaxEntries is how many entries the list can hold, set by its purpose. null if the purpose is no longer configured.
      - `merchant_visibility` string
      - `metadata` object
      - `organization_id` string
      - `purpose` string
      - `updated_at` string
      - `updated_by` string
    - `id` string
    - `type` string
  - `has_more` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

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