This article will cover the following:
- What are Lead Statuses
- Settings to enable Lead Statuses
- Creating Lead Statuses
- Lead Status Master Report
- Update Lead Status API
What are Lead Statuses
Lead Statuses are used to update the status of a lead. There is a buyer specific API that will allow the purchasing buyers to assign a status to a lead. This information from the buyer will be updated in the lead status report to give you real time metrics on lead quality.
Enabling Lead Statuses
Lead Status is a buyer specific setting. Go to your main Setup tab > Settings > Lead Gen Settings > check the Lead Statuses box and click Save.
Creating Lead Statuses
Now that this feature has been enabled in your CAKE instance you can click on the Lead Statuses Sub-Tab on the left.
1. Status: Is the primary status to be assigned to a column in the Lead Status. Example: Funded, Sold Paid in Full, Unqualified, In Progress, etc.
\L 2. Sub stats: Can be assigned as a drill down to the primary column(status).\L
3. Field: This section allows you to add custom fields to be updated via API in real time. To add a new field click Add > assign a label, a field name, Vertical, Buyer or both, and a data type. The data type is important to consider when adding a field, for example you cannot SUM a String data type.
Master Report - Lead Statuses
The Master Lead Status Report houses all of the custom statuses in columns created in the previous step. Example: Funded, Sold Paid in Full, Unqualified, In Progress, etc.
To access the Master Lead Status Report, go to your main Reports tab > Master Reports > Lead Status subtab
Master Report-Lead Statuses
Each line item in this report is the campaign that generated the lead. The sum column (above in red) is used to SUM number fields updated via API. For example, if test_name were a number data type then a value can be assigned. This report would then SUM that value on every updated lead, breaken out by campaign.
This report has 2 filters to display updated leads:
- Show Changes-When enabled, only leads that have been updated will be displayed.
- Show Sub status-When enabled, only leads that have been assigned sub status will be displayed.
IMPORTANT:This report is most closely related to the lead detail by buyer report. When leads have been assigned a status via API they are found by date sold, not date updated.
Update Lead API https://#mycakeinstance.com#/buyers/api/1/leads.asmx
This link to the Update lead API https://#mycakeinstance#.com/buyers/api/1/leads.asmx then click update lead
Update Lead API, Continued
lead_id ~ Cake Lead ID (required)\L
buyer_contract_id ~ Purchasing Buyer Contract ID (required)\L
status ~ Status (optional)
\L sub_status ~ Sub status (optional)\L
amount ~ Revenue on lead
\L add_to_existing ~ Add revenue from amount parameter (true/false)?\L
field_name ~ Field name (name from settings>lead statuses>field section) (optional)\L
field_value ~ Field value (example: dollars_funded) (optional)
\L return_reason_id ~ Return Reason ID (required, see get return reason. If not returning, use 0)
- Statuses and Sub Statuses must be passed exactly as they are in your settings
- If you pass in a Status that does not exist, you will get the following response\L <success>false</success>\L <message>Invalid Lead Status</message>
- If you pass in a Sub Status that does not exist, you will get the following response\L <success>false</success>\L <message>Invalid Lead SubStatus</message>
- Status is required to have a SubStatus
- The amount reflects the revenue of the lead, if a lead was to be returned then you can pass "amount=0&add_to_existing=false" in the example the amount would overwrite the existing revenue on the lead. Then you can assign a return reason.
- Since this report is directly related to the lead status report, you can check your work, by looking up the lead by sold date.
- A lead CAN be updated multiple times. If a lead needs to be updated at each step in a multi-step process it will not effect it.