Use Master API Credentials Instead of User’s API Key

We’ve just made using the API a whole lot easier.

In the past, you had to know your user’s API Key in order to call functions related to their account.  Now, instead of passing their API Key, you can override and use your master apiusername and apipassword instead.   This means you can ditch having to keep and store your user’s API Key.

For any API Function that requires the user’s apikey, leave out the apikey field and instead add the apiusername and apipassword fields.  (To clarify: These are your master API credentials, not the user’s details)

This option is available now.

Additions to AddContactNote

You can now pin a new contact note via the API.   Also, we added the ability to enter a “new line” character in the note.  Please see the updated documentation for details.   AddContactNote

You will have this in the next update, once your installed version is 4/26/2017 or later.

Your choice – API calls can return either XML or JSON Formatted Data

Good news! We’ve gone back and updated all older API functions to include the option to return the result data as JSON or XML data. XML was the only option for the API functions created in the past.

If you still want XML results, you don’t need to do anything. All results default to XML. If you want your results in JSON, add the field “response_type” to your request fields and set the value to “json”.

You can choose whichever format is easiest to consume in your favorite programming language.

Summer API Updates

Here is a summary of new and updated API functions over the last few months:

New API Functions

GetOptInStatusList : Returns the full list of opt in status results for all email addresses in an accounts database.

GetActivityLog : Returns details from the “Activity Log” report

GetPermissions & SetPermissions : Allows for setting and listing team member permissions


Added fields Inactive, OtherEmail, OtherSystemID to GetContacts function

API Updates for April

Updated: GetAccounts

Added option to return group information about all accounts


New Functions: AddSource, AddCategory2

You now have the ability to add Sources and Category2s via the API


UPDATE: More New Functions: GetLetterTemplate, GetLetterTemplates, UpdateCustomFields


GetLetterTemplate (get details on a specific Letter template)
GetLetterTemplates (get a list of Letter Templates)
UpdateCustomFields (update Custom Fields)


These updates will be available in the next update, when your version timestamp is later than 4/27/2016  (version timestamp is located on home page of the admin page)