Welcome to the API Newsletter!

We're excited to bring you the 2nd edition of our newsletter. You can expect this newsletter to arrive in your mailbox on the third Thursday of every month.

Please contact us with any suggestions or feedback about how we can make this more useful for you!
 

API Updates

Methods

We recently added a few methods that allow you to distribute credits between accounts. Please note that this can only be performed by the main admin account within your Partner solution.  Get more information by clicking on one of the links below:

• getEmailCreditBalance()
• transferEmailCredits()
  
  

Tips and Tricks

Profile management

Do you want to allow your customers to be able to manage their profile (email address, first name, last name, etc)? It's pretty easy to set up! Depending on how you manage your lists, if you have one master list or multiple smaller lists, you will first need to determine where the user exists. 

Master List method (email address only exists in one list)

1. Login
2. Get the hash number from getListMemberByEmailAddress()
3. Use the hash to do an editListMember(), to make the necessary modifications.

Multiple Lists Method (email address can exist in various lists)

Note: This can get a bit tricky if you have multiple lists. There must be a 'master' list that you create as a subset of the lists. If you do not have a master list then you will need to update all instances of the email address.

1. Login
2. Get a list of all mailing list IDs through enumerateLists()
3. Do a  loop on all the lists IDs
   • Use getListMemberByEmailAddress()
   • use the hash from getListMemberByEmailAddress()  to modify the member record using editListMember()

Real World Application 

An Example of how this would work: A link can be placed in the campaign called "update profile," this can be something like this <a href="http://.../update_profile.html?email=[EMAIL_ADDRESS]">. The update_profile.html page would be a dynamic form that would get its information from the method getListMemberByEmailAddress(). Once the user has submitted the change you can then use editListMembers() to update the member record.

Coming Soon...

• Knowledge Base
  
• User Forums
  

If you have any questions, concerns or suggestions, send them to api-inquiry@verticalresponse.com
 

In This Issue

• Introduction

• API Updates

• Tips and Tricks

• Coming Soon...
 

Question of the Month 

Q: How long does it take to integrate the API into my environment?

A: Easy answer? - "It depends."  Factors include the the developer's knowledge of VR product and SOAP, as well as the complexity of your current environment. A simple DB sync routine can take a few days to set up, while a deep integration with another in house system (e.g. legacy CRM) can exend this by a few weeks or more.

Enhancements

We are continually adding new features to our system. The most recent enhancement has been our polling mechanism, which allows your script to check with the API server to determine if the job results are completed. You no longer have to keep a session active... you can login, make the call, and a couple of minutes later you can poll the API to determine if the job has been completed.

Cool Website