`getunsubscribelist`

area emailaction getunsubscribelistGETread

This api returns a list of optouts from the unsubscribe list of the account.

Arguments

Argument	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

Example request

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

Response

<response>
  <records>4004</records>
  <optout>
    <id>4010</id>
    <email>test@test.com</email>
    <domain/>
    <datecreated>July 03, 2024, 01:39 pm</datecreated>
    <feedback/>
    <campaignid>2370552</campaignid>
    <ip>203.0.113.1</ip>
    <unsubscribetype>Campaign</unsubscribetype>
  </optout>
</response>

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

`addemail`

POSTwrite

Adds an email to a list, when giving the list id. Also supports custom columns if they already exist in the list just pass the column name via the request.