Update optout list

Update or Merge to an existing optout list.

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.
file Body False Required File The input file in CSV format.

Request

Request Notes

The input file for your merge should include only a list of email addresses, 1 per line. Time stamp and origin are added by Act-On automatically.

If there are duplicate email addresses (either in the uploaded list or already existing as optout records) no error occurs.

Response

When a file is uploaded as a parameter for updating a list, a job id is returned. To obtain an upload status, query the job id.

A successful request results in an HTTP 200 response in JSON like the following:

Status can be queried as follows:

GET /api/1/list/{jobid}/status

This returns a JSON object similar to the following. A successful list upload results in a return of the list id along with a listing of the quantities of appended, updated, failed and rejected records.

If there are rejected records then the status return will include a value for “rejectedRecordsURL”. The API call GET api/1/list/rejectedUploadRecords can then be used to retrieve the file containing the rejected records.

OAuth
Grant Type Password
Grant Type Code
Grant Type Refresh
Account API
Get account information
Create new account user
Delete account users
Delete account user
Get email senders
Fact API
Upload custom events
Get upload custom event status
List API
Get listing of lists
Download a list
Create a new list
Update or merge a list
Get list upload status
Delete a list
Delete records from a list
Get hard bounce list
Get spam complaint list
Get optout list
Update optout list
Get subscription opt-outs by category
mergespecs
uploadspecs
Content API
Get logo list
Get a logo
Add a logo
Update a logo
Delete a logo
Get header list
Get a header
Add a header
Update a header
Delete a header
Get footer list
Get a footer
Add a new footer
Delete a footer
Update a footer
Get image list
Get an image
Add an image
Replace an image
Delete an image
Get media list
Get media file
Add a media file
Add a media link
Update Media File
Delete a media object
Get form list
Get promotional form URLs
Get page list
Get page
Delete page
Get promotional page URLs
Get list of programs
Reporting API
Get message report
Get message report drilldown
Get message report by time period
Get media report
Get media message report
Get a media view report
Get a media timeline report
Get form report
Get page report
Get spam complaint list
Get hard bounce list
Email Campaign API
Get message list
Send a message
Resend a message
Add new template or draft message
Update template or draft message
Delete a message
Get message report
Get message report drilldown
Get message report by time period
Get message HTML contents
Contact API
Add a contact
Get contact record
Upsert a contact record by email
Update a contact by record ID
Delete a contact
Get contact record ID based on cookie ID
Get contact from list based on cookie ID or e-mail
Get contact fact and score data
Get subscription categories
Opt in/Opt out subscription category by email address
Get subscription category opt-ins by email
Opt in/Opt out multiple subscription categories by email address
SEO API
Get SEO keywords
Get a new SEO report
Frequently Asked Questions