Leads API
5 PracBill API endpoints for leads. Base URL https://billing.pracbill.com.au/api.
Create a lead
POST /{api_key}/leads/add
Request body
| Field | Type | Description |
|---|---|---|
lid | integer | Lead id |
Status | string | Current Lead Status |
Company | string | Company Name |
Title | string | Leads Title |
Name | string | First Name |
Middle Name | string | Middle Name |
Surname | string | Last Name |
Sex | string | Gender |
Date Of Birth | string | Date Of Birth |
Logo | string | URL For Logo |
Phone | string | Phone number for Lead |
Mobile | string | Mobile Contact number |
Fax | string | Fax Number |
Email | string | Email Address |
Website | string | Company Website |
Billing Address | string | Billing Address |
Comments | string | Any Comments about the lead |
Security Question | string | A security question for validate Lead |
Security Answer | string | Security Question Answer |
Lead Type | string | Type of lead, this is controlled by a Lookup Table in pracbill "Lead Types" any non matching value may not render |
Lead Source | string | Where the lead came from, this is controlled by a Lookup Table in pracbill "Lead Sources" any non matching value may not render |
Security | string | Security Method to apply |
date_created | string | Date Created |
date_modified | string | Date Last Modified |
Responses
200— Request received successfully
POST /{api_key}/leads/filter/get/page/{page_number}
POST /{api_key}/leads/filter/get/page/{page_number}
Request body
| Field | Type | Description |
|---|---|---|
company | string | company name |
email | string | email address |
phone | string | Phone number |
type | string | The type of lead |
source | string | lead source, where did this lead come from? |
ntoes | string | any internal notes about the lead |
status | string | Current status the lead is in |
Responses
200— Request received successfully
Get a list of paginated leads ( 20 per page )
GET /{api_key}/leads/get/page/{page_number}
Responses
200— Request received successfully
Get a lead
GET /{api_key}/leads/get/{lid}
Responses
200— Request received successfully
Update a lead
POST /{api_key}/leads/{lid}
Request body
| Field | Type | Description |
|---|---|---|
lid | integer | Lead id |
Status | string | Current Lead Status |
Company | string | Company Name |
Title | string | Leads Title |
Name | string | First Name |
Middle Name | string | Middle Name |
Surname | string | Last Name |
Sex | string | Gender |
Date Of Birth | string | Date Of Birth |
Logo | string | URL For Logo |
Phone | string | Phone number for Lead |
Mobile | string | Mobile Contact number |
Fax | string | Fax Number |
Email | string | Email Address |
Website | string | Company Website |
Billing Address | string | Billing Address |
Comments | string | Any Comments about the lead |
Security Question | string | A security question for validate Lead |
Security Answer | string | Security Question Answer |
Lead Type | string | Type of lead, this is controlled by a Lookup Table in pracbill "Lead Types" any non matching value may not render |
Lead Source | string | Where the lead came from, this is controlled by a Lookup Table in pracbill "Lead Sources" any non matching value may not render |
Security | string | Security Method to apply |
date_created | string | Date Created |
date_modified | string | Date Last Modified |
Responses
200— Request received successfully