GET https://api.actonsoftware.com/api/1/list/optout
This endpoint allows you to download the opt-out list from this account.
Customers wanting to access our API via our gateway in the EU can use this link:
GET https://api-eu.actonsoftware.com/api/1/list/optout
Parameters
Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
---|---|---|---|---|---|
authorization | header | false | required | string | Insert your generated access token. (Bearer {access token}) |
count | query | false | optional | string (maximum="1000") | Specify the number of elements to fetch. (Maximum=1000) |
offset | query | false | optional | string | Specify the element offset to begin the fetch. (Default=0) |
createdbefore | query | false | optional | string | Filter records created before the specified date. |
createdafter | query | false | optional | string | Filter records created after the specified date. |
Parameter Notes
createdafter and createdbefore
The parameters return the time in Unix timestamps. A useful convetor can be found here.
Response
{ "offset": 0, "count": 2, "totalCount": -1, "result": [ { "email": "jane.doe@act-on.com", "timestamp": 1567639147559, "origin": "User: John Doe via Act-On API" }, { "email": "john.doe@act-on.com", "timestamp": 1567639147559, "origin": "User: John Doe via Act-On API" } ] }
Note: totalcount will always be -1 and should not be used.
Code Examples
cURL
curl -X GET https://api.actonsoftware.com/api/1/list/optout -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"
Python
import requests url = "https://api.actonsoftware.com/api/1/list/optout" payload = {} headers = { 'Authorization': 'Bearer 12345678-9abc-defg-hijk-lmnopqrs' } response = requests.request("GET", url, headers=headers, data = payload) print(response.text.encode('utf8'))