Get Subscription Opt-Outs by Category
|
1 |
GET /api/1/subscription/optout |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String (Bearer {access token}) | Pass the authentication token that was granted when you authorized access. |
| category | Query | False | Required | String | The subscription category (by name) you would like to obtain an itemized list of opted-out records. * |
| count | Query | False | Optional | String (default="1000", maximum="1000") | Number of records to download. |
| offset | Query | False | Optional | String (default="0") | Index into the list; where to start downloading |
*Note: A list of subscription categories can be obtained with the Get subscription categories endpoint.
Request
|
1 2 3 |
GET /api/1/subscription/optout?category=Test HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs |
Response
A successful request results in an HTTP 200 response with a JSON object like the following. Note that the JSON lists the offset, the number of rows returned, and the total count of rows in the list before listing the data. The JSON object will include email and the timestamp that the opt-out is returned.
Note: Only records that have explicitly opted out of the category will be returned.
|
1 |
{"offset":0,"count":1,"totalCount":1,"result":[{"email":"john.doe@act-on.com","timestamp":1567639430659}]} |
Code Examples
|
1 |
curl -X GET https://restapi.actonsoftware.com/api/1/subscription/optout?category=Test -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs" |
