Upload custom events

Upload a set of custom events with a simple HTTP POST to the Fact API.

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
destination form false Required String Unique displayname of the custom events upload (as it will appear in the custom events listing)
firstrow form false Required String ("Y"|"N") Does the source data contain column headings in the first row of data. Optional flag (default = true if not specified).
fieldseparator form false Required String with restriction - enum { "TAB", "COMMA", "SEMICOLON", "SPACE" } field separator character
quotecharacter form false Required String with restriction - enum { "NONE", "SINGLE_QUOTE", "DOUBLE_QUOTE" } field quote character
customeventaction form false Required String The type of custom event action associated with the uploaded custom events. Should be one of:

CUSTOM_DOWNLOADED
CUSTOM_REGISTERED
CUSTOM_ATTENDED
CUSTOM_GENERAL
CUSTOM_GENERAL1
CUSTOM_GENERAL2
CUSTOM_GENERAL3
CUSTOM_GENERAL4
CUSTOM_GENERAL5

See the parameter notes for more information about the CUSTOM_GENERAL types.
emailcolidx form false Required String Column index (zero-based) in the uploaded source records containing the email address.
datecolidx form false Required String Column index (zero-based) in the uploaded source records containing the date for the custom event.
titlecolidx form false Required String Column index (zero-based) in the uploaded source records containing the title for the custom event (e.g. the downloaded document name, the event name for a registration, etc.)
notecolidx form false Optional String Column index (zero-based) in the uploaded source records containing the an optional note
titlecount form false Required String The expected number of distinct titles in the uploaded custom events. If not specified, then all titles in the upload must match previously uploaded custom event titles. This precaution is necessary to prevent an inadvertently mismapped title field from causing improper proliferation of incorrect custom event titles in Act-On.
dateformat form false Required string The date format to use in parsing the source data in the identified date column. All dates in this column must be represented in this format. Please note that the TIMEZONE used for interpreting dates will be the act-on timezone set for the account login for the authenticated API session. The syntax for this format must be compatible with Java SimpleDateFormat. Examples are: SLASH FORMATS: MM/dd/yyyy (01/25/2011) dd/MM/yyyy (25/01/2011) MM/dd/yy (01/25/2011) dd/MM/yy (01/25/11) yyyy/MM/dd (2011/01/25) DASH FORMATS: MM-dd-yyyy (01-25-2011) dd-MM-yyyy (25-01-2011) MM-dd-yy (01-25-2011) dd-MM-yy (01-25-11) yyyy-MM-dd (2011-01-25) TEXTUAL MONTH: dd MMM yyyy (25 Jan 2011) MMM dd yyyy (Jan 25 2011) dd MMMM yyyy (25 Jaunuary 2011) EEE, dd MMM yyyy (Tue, 25 Jan 2011) EEEE, dd MMMM yyyy (Tuesday, 25 January 2011)
filename form false Required String The name of the attached file
file form false Required file The attached file

Parameter Notes

CUSTOM_GENERAL through CUSTOM_GENERAL5 correspond to the 6 available custom Behavior Names in the AO UI under Contacts -> Other Lists -> Custom Touch Points -> Behavior Names

Click here for a screenshot of how these correspond in the UI

Request

Following are example requests:

HTTP

curl

The above examples used the following file contents:

Last Name,First Name,Email Address,Date,EventTitle,Notes
Lama,Bob,blama@yoga.com,,TradeShow,SomeNote1
Iyengar,B.K.S.,guru@yoga.com,11/01/2015,TradeShow,SomeNote2

Response

If the request succeeds, you’ll get an HTTP 200 response with a JSON object, which represents the resulting job:

The details of the job results can be retrieved using the “Get upload custom event status” API call.

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 value
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