Quick Start

Learn how to get started with the EngineRoom REST API

Get your API key

Your API requests are authenticated using an API key. Any request that doesn't include an API key will return an error.

You can request an API key by emailing [email protected]

Make your first request

To make your first request, send an authenticated request to the leads endpoint. This will create a lead in the EngineRoom platform.

Create a new lead

post

Create a new lead entry

Authorizations
body
lead_datastringOptional

Datetime value the lead was created at, leave blank for current timestamp

Example: 2023-01-01 10:30:00
namestringOptional

Lead Name

Example: John Smith
emailstringOptional

Lead Email Address

Example: [email protected]
phonestringOptional

Lead Phone Number

Example: 0411 111 111
messagestringOptional

Message / Content from Form

Example: I'm looking for a price for a car service
google_client_idstringOptional

Google Client ID

Example: 123456789.98765433
web_sourcestringOptional

Source of Lead E.g "google" or "direct"

Example: google
web_campaignstringOptional

Campaign Attribution

Example: Location Based
web_mediumstringOptional

Medium Attribution E.g "paid" or "organic"

Example: paid
web_keywordstringOptional

Keyword Attribution

Example: Sydney Car Service
form_namestringOptional

Name of form lead completed

Example: Contact Us
urlstringOptional

URL of Lead Acquisition

Example: https://www.sydcarservice.xyz/contact-us
datastringOptional

Additional Information (JSON String)

Example: {"make": "Nissan", "model": "X-Trail", "year": "2022"}
Header parameters
AcceptstringRequired

Request content type

Example: application/json
Responses
201
Lead created successfully
application/json
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"
    }
  }
}
PreviousOverviewNextAuthentication

Last updated