Simpleview API Hub - Act-On Service

You must first obtain a token through the getCRMToken method. This token should be passed into all subsequent calls. URL and Post Headers will be merged, so parameters can generally be sent via either mechanism. The token can often be passed as a url or post parameter , but it is recommended to always pass it as a request header instead as some methods accepting file uploads will require it. The system will attempt to automatically refresh a token before it expires if a call is made within an hour of the expiration date. In addition if a call fails due to an expired token, the system will attempt to refresh it and retry the request. This doesn't seem to be working yet, but it happens infrequently so its hard to track down the reason (though to be honest I haven't tried yet).

Disclaimer: This document is auto-generated and as such, less than perfect. We can clean up toward the end as things are finalized. This API is a work-in-progress

OptInOrOutToSubscriptionCategoryByEmail (returns any)

Parameters:
token [string] REQUIRED email [string] REQUIRED category [string] REQUIRED optInOptOutAction [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/OptInOrOutToSubscriptionCategoryByEmail
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	email: [email],
	category: [category],
	optInOptOutAction: [optInOptOutAction]
	
}
UpdateSubscriptionByEmail (returns any)

Parameters:
token [string] REQUIRED email [string] REQUIRED category [string] REQUIRED optInOptOutAction [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/UpdateSubscriptionByEmail
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	email: [email],
	category: [category],
	optInOptOutAction: [optInOptOutAction]
	
}
authenticate (returns struct)

Parameters:
credentials [struct] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/authenticate
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	credentials: [object]
	
}
createList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/create-new-list/ Create a new list Parameters:
token [string] REQUIRED pathToCSV [string] REQUIRED uploadspecs [string] REQUIRED listname [string] REQUIRED foldername [string] headings [string] REQUIRED fieldseparator [string] REQUIRED quotecharacter [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/createList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSV: [pathToCSV],
	uploadspecs: [uploadspecs],
	listname: [listname],
	foldername: [foldername],
	headings: 'Y',
	fieldseparator: 'COMMA',
	quotecharacter: 'DOUBLE_QUOTE'
	
}
createListV2 (returns any)

Act-On Document:https://developer.act-on.com/endpoint/create-new-list/ Create a new list with zipped CSV. Parameters:
token [string] REQUIRED pathToCSVZip [string] REQUIRED uploadspecs [string] REQUIRED listname [string] REQUIRED foldername [string] headings [string] REQUIRED fieldseparator [string] REQUIRED quotecharacter [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/createListV2
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSVZip: [pathToCSVZip],
	uploadspecs: [uploadspecs],
	listname: [listname],
	foldername: [foldername],
	headings: 'Y',
	fieldseparator: 'COMMA',
	quotecharacter: 'DOUBLE_QUOTE'
	
}
downloadCSV (returns string)

Downloads a CSV from a url and stores it in the temp directory. Returns the local file path to the file Parameters:
urlToFile [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/downloadCSV
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	urlToFile: [urlToFile]
	
}
downloadZip (returns string)

Downloads a CSV from a url and stores it in the temp directory. Returns the local file path to the file Parameters:
urlToFile [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/downloadZip
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	urlToFile: [urlToFile]
	
}
formatEpochs (returns any)

Parameters:
token [string] REQUIRED listid [any] REQUIRED email [any] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/formatEpochs
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listid: [listid],
	email: [email]
	
}
getAuthToken (returns struct)

Parameters:
token [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getAuthToken
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token]
	
}
getCRMToken (returns string)

Get the CRM Token - This will merge the provided credentials with the secret key info tied to this type and return a token for use in future calls. This method may change when we need to start supporting multiple accounts. Type prod is currently bound to the Simpleview Marketing Instance. This will need to be updated to connect to any given CRM. Parameters:
username [string] REQUIRED : Username of User to use for API Requests
 password [string] REQUIRED : Password of User to use for API Requests
 forceNew [boolean] : No matter what should we make a new request to ActOn for a new token
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getCRMToken
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	username: [username],
	password: [password],
	forceNew: boolean
	
}
getCampaignsList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-message-list-by-type/ Get all campaigns by type defaults to SENT Parameters:
token [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getCampaignsList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token]
	
}
getContactByEmail (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-contact-record/ Get contact information based on a list they are in Parameters:
token [string] REQUIRED listid [any] REQUIRED email [any] REQUIRED priority [any]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getContactByEmail
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listid: [listid],
	email: [email],
	priority: [object]
	
}
getContactScoresByEmail (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-contact-fact-data/ Get contact scores and facts Parameters:
token [string] REQUIRED listid [any] REQUIRED email [any] REQUIRED contactid [string]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getContactScoresByEmail
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listid: [listid],
	email: [email],
	contactid: [contactid]
	
}
getHardBounceList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/fetch-hard-bounce-list/ Get a list of all hard bounces during the given time period. Parameters:
token [string] REQUIRED startdate [date] enddate [date] offset [numeric] REQUIRED pagesize [numeric] REQUIRED autopage [boolean] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getHardBounceList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	startdate: [startdate],
	enddate: [enddate],
	offset: numeric,
	pagesize: numeric,
	autopage: boolean
	
}
getListByName (returns struct)

Retrieves all lists of a given type and returns the first one that matches the given name Parameters:
token [string] REQUIRED listName [any] REQUIRED listType [any] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getListByName
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listName: [listName],
	listType: [object]
	
}
getListUploadStatus (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-list-upload-status/ Returns the status of an asynchronous list upload job Parameters:
token [string] REQUIRED jobid [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getListUploadStatus
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	jobid: [jobid]
	
}
getLists (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-list-list/ Returns a list of lists Parameters:
token [string] REQUIRED listType [any] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getLists
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listType: [object]
	
}
getMarketingList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/download-a-list/ Get a list of all contacts in a marketing list Parameters:
token [string] REQUIRED listid [string] REQUIRED startdate [date] enddate [date] fields [string] offset [numeric] REQUIRED pagesize [numeric] REQUIRED responseformat [string] csvName [string] csvPath [string]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getMarketingList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	listid: [listid],
	startdate: [startdate],
	enddate: [enddate],
	fields: [fields],
	offset: numeric,
	pagesize: numeric,
	responseformat: 'json',
	csvName: [csvName],
	csvPath: [csvPath]
	
}
getMessageContents (returns struct)

Act-On Document:https://developer.act-on.com/endpoint/get-sentdrafttemplate-message-html-contents/ Get the contents of a message Parameters:
token [string] REQUIRED msgid [any] REQUIRED recid [any]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getMessageContents
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	msgid: [msgid],
	recid: [recid]
	
}
getMessageList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-message-list-by-type/ Get all messages by type defaults to SENT Parameters:
token [string] REQUIRED msgtype [string]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getMessageList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	msgtype: 'SENT'
	
}
getMessageReport (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-message-report/ Get a report by messageid Parameters:
token [string] REQUIRED msgid [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getMessageReport
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	msgid: [msgid]
	
}
getOptOutList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-optout-list/ Get a list of all unsubscribes during the given time period. Parameters:
token [string] REQUIRED startdate [date] enddate [date] offset [numeric] REQUIRED pagesize [numeric] REQUIRED autopage [boolean] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getOptOutList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	startdate: [startdate],
	enddate: [enddate],
	offset: numeric,
	pagesize: numeric,
	autopage: boolean
	
}
getOptOutLists (returns any)

Act-On Document:https://developer.act-on.com/reference/get_api-1-list-optouts Get a list of all unsubscribes during the given time period. *NEW* Parameters:
token [string] REQUIRED startdate [date] enddate [date]
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getOptOutLists
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	startdate: [startdate],
	enddate: [enddate]
	
}
getSpamComplaintList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-spam-complaint-information/ Get a list of all those with spam complaints during the given time period. Parameters:
token [string] REQUIRED startdate [date] enddate [date] offset [numeric] REQUIRED pagesize [numeric] REQUIRED autopage [boolean] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getSpamComplaintList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	startdate: [startdate],
	enddate: [enddate],
	offset: numeric,
	pagesize: numeric,
	autopage: boolean
	
}
getSubscriptionCategories (returns any)

Act-On Document:https://developer.act-on.com/endpoint/get-subscription-categories/ Get the subscription categories (mailing types) Parameters:
token [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getSubscriptionCategories
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token]
	
}
getSubscriptionCategoriesByEmail (returns any)

Parameters:
token [string] REQUIRED email [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getSubscriptionCategoriesByEmail
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	email: [email]
	
}
getepoch (returns numeric)

Returns the epoch time of the specified date. Poorly tested Parameters:
dte [date] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/getepoch
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	dte: [dte]
	
}
logIt (returns any)

Parameters:
httpResult [any] REQUIRED method [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/logIt
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	httpResult: [httpResult],
	method: 'unknownmethod'
	
}
removeFromOptOutList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/remove-opt-outs/ Remove opted-out contacts (add contacts back to opt-in) Parameters:
token [string] REQUIRED pathToCSV [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/removeFromOptOutList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSV: [pathToCSV]
	
}
updateList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/update-merge-list/ Update an existing list Parameters:
token [string] REQUIRED pathToCSV [string] REQUIRED uploadspecs [string] REQUIRED listid [string] REQUIRED foldername [string] headings [string] REQUIRED fieldseparator [string] REQUIRED quotecharacter [string] REQUIRED mergekey [string] REQUIRED mergeMode [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/updateList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSV: [pathToCSV],
	uploadspecs: [uploadspecs],
	listid: [listid],
	foldername: [foldername],
	headings: 'Y',
	fieldseparator: 'COMMA',
	quotecharacter: 'DOUBLE_QUOTE',
	mergekey: 'email',
	mergeMode: 'REPLACE'
	
}
updateListV2 (returns any)

Act-On Document:https://developer.act-on.com/endpoint/update-merge-list/ Update an existing list with zipped CSV. Parameters:
token [string] REQUIRED pathToCSVZip [string] REQUIRED uploadspecs [string] REQUIRED listid [string] REQUIRED foldername [string] headings [string] REQUIRED fieldseparator [string] REQUIRED quotecharacter [string] REQUIRED mergekey [string] REQUIRED mergeMode [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/updateListV2
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSVZip: [pathToCSVZip],
	uploadspecs: [uploadspecs],
	listid: [listid],
	foldername: [foldername],
	headings: 'Y',
	fieldseparator: 'COMMA',
	quotecharacter: 'DOUBLE_QUOTE',
	mergekey: 'email',
	mergeMode: 'REPLACE'
	
}
updateOptOutList (returns any)

Act-On Document:https://developer.act-on.com/endpoint/update-optout-list/ Update the optout list Parameters:
token [string] REQUIRED pathToCSV [string] REQUIRED
Sample call:
Method: Post
URL: http://actonhub.localhost/apihandler.cfm?resource=/api/v1/services/ActOnObj/updateOptOutList
Request headers: Content Type: Application/JSON
 Token: [crmtoken]
Request Body 
{
	token: [token],
	pathToCSV: [pathToCSV]
	
}