Follow

Custom Integrations: API and Web Services

Velocify™ provides a web service to integrate many of the core functions within the Velocify LeadManager™.The Velocify Web Service enables clients and partners to read and write lead data in LeadManager. This is typically used by clients or third parties to “pull” lead information and use it in other systems or “push” field and status updates for a lead in LeadManager.

 

NOTE: The Velocify Web Service is a self-service tool. If you need assistance troubleshooting the API, please submit a case to our support team.

 

In What Cases Would I Use Velocify's Web Service?

Below are some common cases in which you would use our web service:

 

Uses Case 1: A lead provider wants to retrieve performance data about a lead they sent to a client. They may want to check the status, loan amount, assigned user or other information.

 

Uses Case 2: SparkRoom or another reporting company wants to pull month-end performance data from LeadManager.

 

Uses Case 3: A dialer company wants to update the status of a lead, assign a lead to a new user, or insert some additional data into a lead.

 

Uses Case 4: SoftVu or another marketing company wants to change the status of a lead after the email they sent was read or opened.

 

How Do I Access the Web Service API Documentation?

The Velocify Web Service is an add-on feature for LeadManager clients. In order to access the web service documentation, please contact your account manager to discuss pricing and the use of the web service. Your account manager can then send you the documentation required to build your web service calls.

 

What Operations Can I Do With the Web Service?

  • Add an email to your opt out list
  • Add a new campaign to your database
  • Add a new field group to the FormBuilder in your database
  • Add a new field to the FormBuilder in your database
  • Add new agent to your database
  • Add Security Role for Agent
  • Assign a lead to an agent via a distribution program
  • Execute and return the results of a specified Custom Report
  • Execute and return the results of a specified Custom Report without FilterItems
  • Return a list of field types
  • Modify one or more existing lead(s) in your database
  • Modify the agent assigned to a lead in your database
  • Modify the campaign of a lead in your database
  • Modify the field data within a lead in your database
  • Modify the status of a lead in your database
  • Modify an agent's group
  • Modify an existing agent
  • Remove a campaign from your database
  • Remove a lead from your database
  • Remove a lead from your database
  • Return a list of agent groups in your database
  • Return a list of all possible campaign types
  • Return a list of all possible visibility types
  • Return a list of available actions in your database
  • Return a list of available statuses in your database
  • Return a list of campaigns in your database
  • Return a list of field groups in your database
  • Return a list of fields in your database
  • Return a list of lead distribution programs in your database
  • Return a list of lead milestones in your database
  • Return a list of lead provider integrations in your database
  • Return a list of reports in your database
  • Return a list of users in your database
  • Return a list of users that are available to receive a specific lead
  • Return a list of users that are qualified to receive a specific lead and the lead information
  • Return a list of users that are within a specified group
  • Return a single lead
  • Return a user in your database
  • Return current date and time from the Velocify data server in Pacific time
  • Return the current version of the Web Service
  • Return lead(s) that have been created within a specific time duration. Based on CreateDate
  • Return lead(s) that have been modified in the past X minutes. Based on ModifyDate
  • Return most recently created lead by phone and agents qualified to receive lead
  • Return the ID of lead(s) that have been created within a specific time duration. Based on CreateDate
  • Return the ID of lead(s) that have been modified in the past X minutes. Based on ModifyDate
  • Return the last lead added to your database
  • Return the most recently modified lead in your database
  • Search for leads by phone
  • Search for the most recently created lead and a list of users that are qualified to receive this lead by phone
  • Take an action on an existing lead in your database
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk