email - getunsubscribelist

API Call Information

area: email

action: getunsubscribelist

API Arguments

Argument	Data Type	Required	Description
`start`	integer	No	Starting position
`limit`	integer	No	Number of records to return
`campaignid`	integer	No	id of the campaign to only show the unsubscribes from that campaign

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getunsubscribelist&start=0&limit=10

API Response

XML Response

<response>

  <records>4004</records>

  <optout>

    <id>4010</id>

    <email>test@test.com</email>

    <domain/>

    <datecreated>July 03, 2024, 01:39 pm</datecreated>

    <feedback><![CDATA[]]></feedback>

    <campaignid>2370552</campaignid>

    <ip>191.181.213.34</ip>

    <unsubscribetype>Campaign</unsubscribetype>

  </optout>

</response>

JSON Response

{
    "records": "4004",
    "optout": {
        "id": "4010",
        "email": "test@test.com",
        "domain": "",
        "datecreated": "July 03, 2024, 01:39 pm",
        "feedback": "",
        "campaignid": "2370552",
        "ip": "191.181.213.34",
        "unsubscribetype": "Campaign"
    }
}