Get Opt-Outs by Subscription Category

GET https://restapi.actonsoftware.com/api/1/subscription/optout

This endpoint will allow you to download the list of records that have opted out of a specific subscription category.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
(Bearer {access token})
category Query False Required String Specify the name of the subscription.
count Query False Optional String Specify the number of elements to fetch.
(Maximum=1000)
offset Query False Optional String Specify the element offset to begin the fetch.
(Default=0)

Response

{
  "offset": 0,
  "count": 1,
  "totalCount": 1,
  "result": [
    {
      "email": "john.doe@act-on.com",
      "timestamp": 1567639430659
    }
  ]
}

Code Examples

cURLPython

curl -X GET https://restapi.actonsoftware.com/api/1/subscription/optout?category=Test -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"

import requests

url = "https://restapi.actonsoftware.com/api/1/subscription/optout?category=Test"

payload = {}
headers = {
  'Authorization': 'Bearer 12345678-9abc-defg-hijk-lmnopqrs'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))