← Back to API List

email - mergelist

Merges multiple lists together into a new list. Keeps the original list!

API Call Information

area: email

action: mergelist

API Arguments

Argument	Data Type	Required	Description
title	string	Yes	Title of the new list created.
listids	string	Yes	A comma separated list of list ids to merge together. Rules no more than 15 lists, and no more than 4 million records total. If you need higher limits contact us.
emailonly	boolean either 1 or 0	No	Merge only email column and not all columns in the list into the new list.

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=mergelist&listids=2,4,6&title=newlisttitle

API Response

XML Response

<response>
  <success>List Merge in progress. Use a notification webhook to get the ID of the newly created list</success>
</response>

JSON Response

{
    "success": "List Merge in progress. Use a notification webhook to get the ID of the newly created list"
}