An Important Note
This API is not designed to be polled frequently, so please exhibit responsible behavior when calling the API in a loop. A good rule of thumb: if you're polling for changes, limit your calls to once or twice per day. Evening and overnight hours are better than mid-day. If you make multiple simultaneous API requests (e.g., with multiple threads), the number of concurrent calls should not exceed three.
Abuse of API resources may result in revocation of access, in order to guarantee availability for other users.
Authentication with an API Key
The preferred way to authenticate is to use an API key. You can manage your API key on your Account page in LeadConduit Classic. There are two levels of API key access: limited and full.
- Limited access - provides access only to campaign configuration data, such as: campaigns, their fields, and your lead sources.
Neither key exists in your account until an administrator creates it. This assures that there is only API access to your data if it's been granted by one of your administrators.
Example using sample API key with curl:
curl -X GET https://api.leadconduit.com/campaigns?api_key=limitedapikey
Authentication with User ID and Password
The API can also be accessed using a LeadConduit Classic user login (email and password). This authentication method isn't recommended, because it ties usage to a particular user, either a real person or a fictitious login created solely for this purpose. Coordinating password changes and campaign access with this method can become troublesome over time.
When you're using the API with your user login, it's always from that perspective. You are only able to access the statistics you can normally see while logged in to LeadConduit Classic. Authentication is done using HTTP Basic with the same credentials you use to log in to LeadConduit Classic.
Example using sample credentials through curl:
curl -X GET -u firstname.lastname@example.org:password https://api.leadconduit.com/campaigns
Remember that anyone who has an email address and password in your LeadConduit Classic account can read stats via the API, just as they can when logged into LeadConduit Classic. Protect your password closely. If you fear that your password has been compromised, reset it in LeadConduit Classic and update your calls to the API.
User ID Implementation Note
Some HTTP Client libraries (Jakarta HttpClient, for example), do not send Basic credentials with every request by default. Instead, they send a request without credentials, and if a HTTP 401 is received, they reissue the request with the credentials. Please make the necessary configuration adjustments to ensure that Basic credentials are sent with every HTTP request.
The central concept in RESTful architectures is a "resource." Generally speaking, a resource is known by a unique identifier. In LeadConduit Classic, a Lead and a Campaign are both examples of a resource. Each has a unique identifier and information about each resource can be retrieved from the API by the corresponding identifier.
The API documentation also refers to some resources that do not have unique identifiers. For example, there is a special resource for retrieving financial statistics for the last 30 days. There is no unique ID that references this resource. Resources without IDs are read-only (that is, you must use HTTP GET to fetch these resources).
LeadConduit API Resources
See the following pages for details of how to access these resources via the LeadConduit API:
- Campaign Fields
- Leads requires "full access" API key
- Statistics requires "full access" API key
- Sources & Recipients
- Legacy Node IDs
You must use the appropriate HTTP verb (GET, PUT, DELETE, POST) for the operation you are performing. The API documentation specifies which verb to use for each operation. Here are the general guidelines for how the API implements REST:
- GET — Retrieve a resource (i.e. a list of leads, a single lead, or statistics for today's lead flow).
- PUT — Update a resource that already exists (i.e. return a lead, or mark a lead as converted).
- POST — This HTTP verb is only used to overload PUT. You cannot create new resources through the LeadConduit API
- DELETE — Delete a resource. The only resource that can be deleted via this API is a lead.
A note about parameters
Note that all parameters are lower case. Providing
campaign_Id instead of
campaign_id will result in that parameter being disregarded. See more about common API parameters.