← Back to API List

email - uploadlistbyurl

Uploads a list to the account given a url to a list.

API Call Information

area: email

action: uploadlistbyurl

API Arguments

Argument	Data Type	Required	Description
url	string	Yes	a string containing the url to list. Must end with .txt, .csv, Url must start with http:// or https://
suppression	boolean either 1 or 0	No	1 for is a suppression or 0 for not suppression

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=uploadlistbyurl&url=http://ww.yoursite.com/yourlist.csv

API Response

XML Response

<response>
  <id>1</id>
  <status>Processing</status>
</response>

JSON Response

{
    "id": "1",
    "status": "Processing"
}