uploadspecs

Uploadspecs are needed for handling lists when you perform any of the following list operations:

  • create
  • update
  • merge

Uploadspecs is JSON object to describe the structure of the file you are uploading when creating a new list, or the structure of the destination when merging. You pass uploadspecs as a form parameter to identify column headings and how you want Act-On to handle them for you.

There must be a verbatim match between columns in the source and destination list when merging.  Mapping of columns with differing header names is planned as part of a v2 revision of this endpoint.

Requirements:

  • You must specify the EMAIL system usage column for an upload or merge to succeed.
  • The columnType parameter will only accept the system fields listed below. Empty or misspelled values will return an error stating "Upload specs contain an invalid column type value."

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
columnType True Optional except for EMAIL String This specifies the EMAIL system usage column and will set system field mappings for the other system fields on creation of a new list.

System fields:
- EMAIL
- FIRSTNAME
- LASTNAME
- MIDDLENAME
- COMPANY
- JOBTITLE
- DEPT
- BIZ_STREET
- BIZ_CITY
- BIZ_STATE
- BIZ_ZIP
- BIZ_COUNTRY
- HOME_STREET
- HOME_CITY
- HOME_STATE
- HOME_ZIP
- HOME_COUNTRY
- BIZ_PHONE
- BIZ_FAX
- HOME_PHONE
- HOME_FAX
- CELL_PHONE
- BIZ_WEB
- HOME_WEB
columnHeading false Required String display name for column heading
columnIndex Required String column index within the uploaded file
ignoreColumn Optional String Can either be "Y" or "N". It will specify whether this column should be ignored or not. Defaults to N and any value other than "Y" will be treated as a "N".

Code Examples

List with six columns using system and custom fields

A typical list might start with six columns in a pattern like the following:

  • First Name
  • Last Name
  • Email
  • Custom 1
  • Custom 2
  • Sensitive information

In this example, we map First Name, Last Name and Email to the corresponding system fields, import Custom 1 and Custom 2 without mapping to system values, and set the column that contains Sensitive Information so that it is ignored (not imported) by Act-On.

List using all twenty-two system fields

Following is an example uploadspecs that includes all of Act-On the system fields.

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