Email Lists

Create email list

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.

post/v1/email_lists

Request

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

Request body

descriptionstring

merchant_visibility'hidden' | 'read_only' | 'editable'

metadataobject

organization_idstring

purposestring required

Example request

{
  "description": "Recipients of dispute notification emails",
  "entries": [
    {
      "email": "disputes@example.com",
      "name": "Disputes team"
    }
  ],
  "merchant_visibility": "editable",
  "organization_id": "org_123",
  "purpose": "disputes"
}

Response

Created

has_moreboolean

Example response

{
  "data": {
    "attributes": {
      "created_at": "2026-10-23 08:00:00+00:00",
      "created_by": "admin_123",
      "description": "Recipients of dispute notification emails",
      "entries": [
        {
          "email": "disputes@example.com",
          "name": "Disputes team"
        }
      ],
      "max_entries": 50,
      "merchant_visibility": "editable",
      "organization_id": "org_123",
      "purpose": "disputes",
      "updated_at": "2026-10-23 08:00:00+00:00",
      "updated_by": "admin_123"
    },
    "id": "eml_3f9a1c7e5b2d4a6c8e0f1a2b",
    "type": "email_list"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.