List API Documentation

This page summarizes information on the List API endpoints that Act-On Software offers to developers and customers. For information on working directly with contacts in a list, please see the Contact API documentation You can click through to find details on each endpoint. For questions, please post to our developers forum.

All API calls to Act-On Software should be made to the "https://restapi.actonsoftware.com" base domain.

Working with lists

Using the Act-On APIs, you can create, update, and merge into lists. For this functionality, you need to know how to get the ID of your newly created list or of any list(s) with which you want to work, and you need to understand how to create and use both uploadSpecs and mergeSpecs.

Any time that you create a new list, the list ID is returned. Once you create a list using POST /api/1/list with uploadspecs (to indicate the headings/system that you need), you can merge your list data using a csv file.

To get the ID for all lists that exist within any Act-On account, use GET list listing (listed in the endpoints table below).

Method Name

Endpoint

  • 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

  • uploadspecs

  • mergespecs

  • Get rejected records from an upload

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