UploadSpecs Overview

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

  • create
  • update
  • merge

Uploadspecs is a JSON object to describe the structure of the file you are uploading when creating a new list, or the structure of the desitnation 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 succedd.
  • 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

Required/Optional

Data Type

Description

columnType

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

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".

Example

[

        {
            "columnHeading": "First Name",
            "ignoreColumn": "N",
            "columnType": "FIRSTNAME",
            "columnIndex": 0
        },
        {
            "columnHeading": "Email",
            "ignoreColumn": "N",
            "columnType": "EMAIL",
            "columnIndex": 1
        },
        {
            "columnHeading": "Last Name",
            "ignoreColumn": "N",
            "columnType": "LASTNAME",
            "columnIndex": 2
        },
        {
            "columnHeading": "Company",
            "ignoreColumn": "N",
            "columnType": "COMPANY",
            "columnIndex": 3
        },
        {
            "columnHeading": "Title",
            "ignoreColumn": "N",
            "columnType": "JOBTITLE",
            "columnIndex": 4
        },
        {
            "columnHeading": "Department",
            "ignoreColumn": "N",
            "columnType": "DEPT",
            "columnIndex": 5
        },
        {
            "columnHeading": "Street",
            "ignoreColumn": "N",
            "columnType": "BIZ_STREET",
            "columnIndex": 6
        },
        {
            "columnHeading": "City",
            "ignoreColumn": "N",
            "columnType": "BIZ_CITY",
            "columnIndex": 7
        },
        {
            "columnHeading": "State",
            "ignoreColumn": "N",
            "columnType": "BIZ_STATE",
            "columnIndex": 8
        },
        {
            "columnHeading": "ZIP Code",
            "ignoreColumn": "N",
            "columnType": "BIZ_ZIP",
            "columnIndex": 9
        },
        {
            "columnHeading": "Country",
            "ignoreColumn": "N",
            "columnType": "BIZ_COUNTRY",
            "columnIndex": 10
        },
        {
            "columnHeading": "HStreet",
            "ignoreColumn": "N",
            "columnType": "HOME_STREET",
            "columnIndex": 11
        },
        {
            "columnHeading": "HCity",
            "ignoreColumn": "N",
            "columnType": "HOME_CITY",
            "columnIndex": 12
        },
        {
            "columnHeading": "HProvince",
            "ignoreColumn": "N",
            "columnType": "HOME_STATE",
            "columnIndex": 13
        },
        {
            "columnHeading": "HZIP Code",
            "ignoreColumn": "N",
            "columnType": "HOME_ZIP",
            "columnIndex": 14
        },
        {
            "columnHeading": "HCountry",
            "ignoreColumn": "N",
            "columnType": "HOME_COUNTRY",
            "columnIndex": 15
        },
        {
            "columnHeading": "PHone",
            "ignoreColumn": "N",
            "columnType": "BIZ_PHONE",
            "columnIndex": 16
        },
        {
            "columnHeading": "Fax",
            "ignoreColumn": "N",
            "columnType": "BIZ_FAX",
            "columnIndex": 17
        },
        {
            "columnHeading": "HPhone",
            "ignoreColumn": "N",
            "columnType": "HOME_PHONE",
            "columnIndex": 18
        },
        {
            "columnHeading": "HFax",
            "ignoreColumn": "N",
            "columnType": "HOME_FAX",
            "columnIndex": 19
        },
        {
            "columnHeading": "CELL",
            "ignoreColumn": "N",
            "columnType": "CELL_PHONE",
            "columnIndex": 20
        },
        {
            "columnHeading": "URL",
            "ignoreColumn": "N",
            "columnType": "BIZ_WEB",
            "columnIndex": 21
        },
        {
            "columnHeading": "HURL",
            "ignoreColumn": "N",
            "columnType": "HOME_WEB",
            "columnIndex": 22
        }
    ]