PApaymongo
Email Lists

Replace email list entries

Replace the addresses in an email list with the given set, in one step. Send an empty entries array to clear the list. Addresses are lower-cased and must be unique within the list. Internal callers only. Requires an S2S token with an admin_id claim, recorded in created_by and updated_by; without one, 401.

put/v1/email_lists/{id}/entries

Request

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

Path parameters

idstring required

Email list ID

Request body

Example request

{
  "entries": [
    {
      "email": "disputes@example.com",
      "name": "Disputes team"
    }
  ]
}

Response

OK

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.