GET https://restapi.actonsoftware.com/ucl/v2/segment/{accountId}/optout
This endpoint allows you to download the All Contacts opt-out list from this account.
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
|
authorization |
header | false | required | string |
Insert your generated access token. (Bearer {access token}) |
| accountID | Path | false | required | number | Account ID where query needs to be done |
| pageSize | Query | false | optional | number (maximum=1000) |
Specify the number of elements to fetch. (Default=100) (Maximum=1000) |
| pageNumber | Query | false | optional | number |
Specify the element offset to begin the fetch. (Default=1) |
Response
{
"listId": "t",
"headers": [
"_contact_id_",
"Timestamp",
"Origin",
"ObjectType",
"Act-On Primary Score",
"First Name",
"Last Name",
"Company",
"Department",
"Email",
"Title",
"Mailing Street",
"Mailing City",
"Mailing State/Province",
"Mailing Zip/Postal Code",
"Mailing Country",
"Other Street",
"Other City",
"Other Zip/Postal Code",
"Other Country",
"Business Phone",
"Business Fax",
"Other Phone",
"Mobile Phone",
"Website",
"Other State/Province",
"Created Date",
"Modified Date"
],
"search": null,
"offset": 1,
"data": [
[
"l-unified-contacts:cc",
"Thu May 13 2021, 03:00 PM",
"Program: ccc",
"Lead",
"0",
"John",
"Doe",
"TEST",
"",
"john.doe@act-on.net",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"Aug 30 2022 13:06 Pacific/Marquesas",
"Aug 30 2022 13:44 Pacific/Marquesas"
]
"hasNextPage": false,
"count": 100,
"totalCount": 1378
}
Code Examples
cURL
curl -X GET https://restapi.actonsoftware.com/ucl/v2/segment/{accountId}/optout -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"
