OBSOLETE Claritysoft API Documentation

Please check the current API documentation at http://liveapi.claritysoftcrm.com/help

Claritysoft CRM provides an API (Application Programming Interface) to allow users to import data from their web site directly to Claritysoft. This will allow you to import leads from your web site, and work with them in Claritysoft.

The current version of the Claritysoft API provides the following abilities:

• Check the existence of a lead based on the email address

• Check the existence of a contact based on the email address

• Check the existence of a account based on the name

• Create a Contact including User field

• Create an Account including User field

• Create a Lead including User field

• Create a Quotation including User field

• Create an Opportunity including User field

• Create a Sale including User field

• Create an activity for a lead

• Create an activity for a contact

In order to communicate with your database, you will need to create an API key. This will allow you to log in and execute the API on your database. It is important to understand that the API populates your server database and not your local database. To see the changes, you will need to synchronize your Claritysoft Application with the server, unless you use www.claritysoftcrm.com through your browser.

To create your API key, follow those steps:

1. Open https://api.claritycrm.com/

2. Under Getting Started, select the link to create a new API key.

3. Login with your Claritysoft user name, password, and server database name.

4. Click Submit

5. Select Create New API key

6. Click Submit. There is no need to fill in any values.