Leads
Use the REST API to interact with Leads
List leads
Retrieve a list of leads
Authorizations
Header parameters
AcceptstringRequiredExample:
Setting to application/json
is recommended
application/json
Responses
200
Success
application/json
401
Unauthorised
application/json
get
GET /public/leads HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
[
{
"id": "751dd3d0-23ae-4a4a-9049-6982423da87a",
"type": "form",
"google_client_id": 123456789.98765433,
"lead_date": "2023-01-01 10:30:00",
"name": "John Smith",
"email": "[email protected]",
"phone": "0411 111 111",
"message": "I'm looking for a price for a car service",
"web_source": "google",
"web_campaign": "Location Based",
"web_medium": "paid",
"web_keyword": "Sydney Car Service",
"quality_score": 6.5,
"engagement_score": 8,
"form_name": "Contact Us",
"url": "https://www.sydcarservice.xyz/contact-us",
"data": {
"make": "Nissan",
"year": 2022,
"model": "X-Trail"
},
"link": "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa",
"business": {
"id": "46580dbc-da00-4316-9a2d-c04a133741aa",
"name": "XYZ Car Servicing"
}
}
]
Creating a new lead
Create a new lead entry
Authorizations
body
lead_datastringOptionalExample:
Datetime value the lead was created at, leave blank for current timestamp
2023-01-01 10:30:00
namestringOptionalExample:
Lead Name
John Smith
phonestringOptionalExample:
Lead Phone Number
0411 111 111
messagestringOptionalExample:
Message / Content from Form
I'm looking for a price for a car service
google_client_idstringOptionalExample:
Google Client ID
123456789.98765433
web_sourcestringOptionalExample:
Source of Lead E.g "google" or "direct"
google
web_campaignstringOptionalExample:
Campaign Attribution
Location Based
web_mediumstringOptionalExample:
Medium Attribution E.g "paid" or "organic"
paid
web_keywordstringOptionalExample:
Keyword Attribution
Sydney Car Service
form_namestringOptionalExample:
Name of form lead completed
Contact Us
urlstringOptionalExample:
URL of Lead Acquisition
https://www.sydcarservice.xyz/contact-us
datastringOptionalExample:
Additional Information (JSON String)
{"make": "Nissan", "model": "X-Trail", "year": "2022"}
Header parameters
AcceptstringRequiredExample:
Request content type
application/json
Responses
201
Lead created successfully
application/json
400
Invalid input
post
POST /public/leads HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
{
"message": "Lead created successfully.",
"data": {
"id": "b0a00e1a-7748-4c68-acd1-36bc74ec0b7b",
"type": "form",
"google_client_id": 123456789.98765433,
"lead_date": "2023-01-30T03:21:49.005548Z",
"name": "John Smith",
"email": "[email protected]",
"phone": "0411 111 111",
"message": "I'm looking for a price for a car service",
"web_source": "google",
"web_campaign": "Location Based",
"web_medium": "paid",
"web_keyword": "Sydney Car Service",
"url": "https://www.sydcarservice.xyz/contact-us",
"data": {
"make": "Nissan",
"model": "X-Trail",
"year": "2022"
},
"link": "https://app.engineroom.com.au/leads/b0a00e1a-7748-4c68-acd1-36bc74ec0b7b&business=cb50eb42-22b3-4df4-bbcd-efcd9694f3f8\"",
"business": {
"id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
"name": "XYZ Car Servicing"
}
}
}
Get lead
Retrieve a single lead
Authorizations
Path parameters
idstringRequiredExample:
Lead ID
751dd3d0-23ae-4a4a-9049-6982423da87a
Header parameters
AcceptstringRequiredExample:
Setting to application/json
is recommended
application/json
Responses
200
Success
application/json
401
Unauthorised
application/json
get
GET /public/leads/{id} HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
{
"id": "751dd3d0-23ae-4a4a-9049-6982423da87a",
"type": "form",
"google_client_id": 123456789.98765433,
"lead_date": "2023-01-01 10:30:00",
"name": "John Smith",
"email": "[email protected]",
"phone": "0411 111 111",
"message": "I'm looking for a price for a car service",
"web_source": "google",
"web_campaign": "Location Based",
"web_medium": "paid",
"web_keyword": "Sydney Car Service",
"quality_score": 6.5,
"engagement_score": 8,
"form_name": "Contact Us",
"url": "https://www.sydcarservice.xyz/contact-us",
"data": {
"make": "Nissan",
"year": 2022,
"model": "X-Trail"
},
"link": "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa",
"business": {
"id": "46580dbc-da00-4316-9a2d-c04a133741aa",
"name": "XYZ Car Servicing"
}
}
Last updated