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 [e-mail]

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

Create a new lead entry

post

/leads

Authorizations

body

lead_datastring

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

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

namestring

Lead Name

Example: John Smith

emailstring

Lead Email Address

Example: [e-mail]

phonestring

Lead Phone Number

Example: 0411 111 111

messagestring

Message / Content from Form

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

google_client_idstring

Google Client ID

Example: 123456789.98765433

web_sourcestring

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

Example: google

web_campaignstring

Campaign Attribution

Example: Location Based

web_mediumstring

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

Example: paid

web_keywordstring

Keyword Attribution

Example: Sydney Car Service

form_namestring

Name of form lead completed

Example: Contact Us

urlstring

URL of Lead Acquisition

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

datastring

Additional Information (JSON String)

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

Header parameters

Acceptstringrequired

Request content type

Example: application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api2.engineroom.com.au/public/leads' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

201

400

201

{
  "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": "[e-mail]",
    "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",
    "link": "https://app.engineroom.com.au/leads/b0a00e1a-7748-4c68-acd1-36bc74ec0b7b&business=cb50eb42-22b3-4df4-bbcd-efcd9694f3f8\"",
    "data": {
      "make": "Nissan",
      "model": "X-Trail",
      "year": "2022"
    },
    "business": {
      "id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
      "name": "XYZ Car Servicing"
    }
  }
}

Lead created successfully