---
title: "Create email list"
method: POST
path: "/v1/email_lists"
tags: ["Email Lists"]
---

# Create email list

`POST /v1/email_lists`

## Request

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

Create an email list for a purpose, such as disputes. Each organization has at most one list per purpose, and so does the global scope (no organization_id); a second one is rejected with 409. Internal callers only. Requires an S2S token with an admin_id claim, recorded in created_by and updated_by; without one, 401.

## Request body

- CreateEmailListRequestDTO
  - `description` string
  - `entries` EntryRequestDTO[]
    - `email` string, required
    - `name` string
  - `merchant_visibility` 'hidden' | 'read_only' | 'editable'
  - `metadata` object
  - `organization_id` string
  - `purpose` string, required

## Response `201`

Created

- 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
- `409`: Conflict
- `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)