Version: 2.0.0
Basic API for creating lead objects for your RLM pipeline.
| Path | Operation | Description |
|---|---|---|
| /api/v1/organization | GET |
Organization Info |
| /api/v1/pipeline/{apiKey} | GET |
Pipeline Info |
| /api/v1/pipeline/{apiKey}/leads/{status} | GET | |
| /api/{apiKey}/lead/{leadID} | GET |
Lead detail |
| /api/{apiKey}/leads | POST |
Create Lead |
Organization and user authentication via header values.
Display organization setup information. Will include location, division and pipeline info.
application/json
Status 200
| Header-based Authentication |
Display organization setup information. Will include location, division and pipeline info.
| apiKey | path | string |
application/json
Status 200
| Header-based Authentication |
| by_date | Query leads based on a date criteria. |
query | string | |
| by_date_at | YYYY-MM-DD for by_date filter |
query | string (date) | |
| by_datetime_since | YYYY-MM-DD HH:MM:SS |
query | string (date-time) | |
| apiKey | path | string | ||
| status | One of the four main lead statuses |
path | string |
Uses default content-types: application/json
Status 200
| Header-based Authentication |
| apiKey | path | string | ||
| leadID | path | integer |
Uses default content-types: application/json
Status 200
To create a lead, post a single lead object to this endpoint. Fields that are an exact match to a lead attribute will map directly. Fields that do not match a lead attribute will be collected and added as a note object after the lead is created.
application/json
| apiKey | path | string |
application/json
Success
Newly created lead ID
No Data or Error
detailed error messages if applicable
Core lead object. Single object includes all relevant detail information required for movement of the lead through the pipeline.
Dealer Store Location
Dealer Sales Division
Lead Source
A specific channel based on the lead source. String value must match based on pipeline field options.
Company Name
Contact First Name
Contact Last Name
Contact Title
Contact Email Address
Website
Main Phone
Mobile Phone
Work Phone
Work Phone Extension
Address Line 1
Address Line 2
City
State Abbreviation
Deal Name
String value must match based on pipeline field options.
Additional text description of referral source
List of product lines
Email marketing permission opt-in
Special offer or promotional code. String value must match based on pipeline field options.
Initial comments or request detail
Lead statuses are one of open or closed and control the flow of a lead through the sales process.
Internal ID
Status Name
Whether or not this is a closed lead status.
Column names for fields to be displayed on the task tray for this status.
Task type names for dropdown selection on the task tray for this status.
Name of required task type for this status
Organizations are the parent objects for pipelines, leads, tasks and users.
Time of day to deliver daily agenda email
Time of day to deliver daily stalled emails
Pipelines are the high-level containers of Leads in RLM. Pipeline configurations are customizable and unique for every customer.
Is the samples module activated for this pipeline?
Pipeline field names that can be edited within the samples module
Default division for leads created via the API
Default location for leads created via the API
Default salesperson for leads created via the API
An individual data field that belongs to the lead object. Customization options including select and multiselect values, front-end display settings and custom API field mappings all contained within each pipeline field object.
internal id
This field is active.
This field is required.
Display Name
Mapped column name in lead table
List of options for select and multiple_select field types
Helper text to display alongside field on lead edit pages
Mapping field name expected from Create Lead API POST
Display options true/false for RLM sections
Show field on New Lead page?
Show field on Detail Lead page
Show field on Edit Lead page
Show field on Lead Listing page
Show field on Task Listing page
Show field on Sample Listing page
Column positioning for New, Detail and Show pages
Column ordering for New, Detail and Show pages