Call us toll-free @ 888-497-7898

API Call Information

area: sms

action: getunsubscribelist

API Arguments

Argument Data Type Required Description
start integer No Starting position of number of records
limit integer No Number of records to return

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=sms&action=getunsubscribelist

API Response

XML Response

<response>
  <records>1</records>
  <optout>
    <id>342</id>
    <mobile>1235200572</mobile>
    <datecreated><![CDATA[October 16, 2024, 04:53 pm]]></datecreated>
    <campaignid>0</campaignid>
  </optout>
</response>

JSON Response

{
    "records": "1",
    "optout": {
        "id": "342",
        "mobile": "1235200572",
        "datecreated": "October 16, 2024, 04:53 pm",
        "campaignid": "0"
    }
}