lead-service-docs.lightspeedhq.com Open in urlscan Pro
104.17.43.56  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (3)

 * Body
 * Headers (3)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Marketing Lead Service
Introduction
Lead Activity
Sandbox
Golf


MARKETING LEAD SERVICE

--------------------------------------------------------------------------------


ABOUT

The marketing lead-service api is a collection of endpoints to collect lead
activity or events into the Lightspeed eco-system.


AUTHENTICATION

In order to authenticate to the API each call needs to contain the following
headers

Plain Text


- `Authorization: Bearer [ YOUR_KEY ]`
- `Client-Secret: [ YOUR_SECRET ]`

In order to receive your key and secret please communicate with Lightspeed
marketing department

REQUIRED FIELDS

email [string]
partner [string]


CUSTOM ENDPOINTS

If for some reason your organization needs a custom endpoint please communicate
with the Lightspeed marketing department.


ACCEPTED CONTENT TYPES

Please include the Content-Type header with each call. For examples and format,
see individual endpoint documentation.

Accepted:

   
 * application/json (preferred)
   
 * text/plain
   
 * application/xml or text/xml
   
 * application/x-www-form-urlencoded
   
 * multipart/form-data
   

NOTES:

The API will respond in the same content-type specified by the call. Except for
x-www-form-urlencoded and form-data that will response in text/pain


LEAD ACTIVITY

The endpoint to submit leads into the Lightspeed eco-system. Please, DO NOT use
this endpoint to submit golf leads. Please, DO NOT use this endpoint to test
leads.

REQUIRED FIELDS

email [string]

partner [string] - Ask Lightspeed representative for the right partner name for
your specific case. We can't find leads by email and assign them to you if the
partner field is missing

AUTHORIZATIONBearer Token
Token

{{ API_KEY }}




POSTAPPLICATION/JSON


{{host}}/lead/activity
AUTHORIZATIONBearer Token
Token

{{bearer}}

HEADERS
Content-Type

application/json

Client-Secret

{{clientsecret}}

Bodyraw

{{req_body}}

Example Request
successfull request

View More
curl


curl --location -g '{{host}}/lead/activity' \
--header 'Content-Type: application/json' \
--header 'Client-Secret: {{clientsecret}}' \
--header 'Authorization: Bearer {{bearer}}' \
--data-raw '{
    "affiliate_name": "chambray",
    "business_type": "Bike",
    "campaign_content": "sponge singer clover hiss sunrise",
    "campaign_medium": "touch buffalo",
    "campaign_name": "hexagon griffin",
    "campaign_source": "tundra green",
    "city": "Sakamie",
    "company": "flannel jelly",
    "continent": "Antarctica",
    "country": "Canada",
    "country_code": "CA",
    "email": "dreamy.herschel_59@lightspeedhq.com",
    "first_name": "dreamy",
    "form_detailed": "trail rights",
    "form_name": "loyalty_watch_demo_steps",
    "form_type": "white-paper bofu",
    "g_click_id": "PuyYcM7JNPK6AU89pkqwHMiBmlMlLu",
    "ga_client_id": "9SKbRTO-B-yhZhZkWd6m-cVvuuIRO_",
    "ga_track_id": "Vx5jQvirNvOjhfVM8G97uvZ9z",
    "general_opt_in": "0",
    "image_url": "www.example.com/url/",
    "language": "nl",
    "last_name": "herschel",
    "page_source": "www.example.com/url/",
    "phone": "9950515329",
    "product": "POSIOS",
    "reseller": "sequoia",
    "state": "Manitoba",
    "state_code": "MB",
    "tld": "Ms",
    "trial_id": "85904",
    "website": "www.lightspeedhq.nl"
}'

201 Created
Example Response
 * Body
 * Headers (3)

json


{
  "message": "created"
}

Content-Type

application/json

Date

Thu, 25 Apr 2019 13:59:14 GMT

Content-Length

22


POSTTEXT/PLAIN


{{host}}/lead/activity
AUTHORIZATIONBearer Token
Token

{{bearer}}

HEADERS
Content-Type

text/plain

Client-Secret

{{clientsecret}}

Bodyraw (text)
View More
text


partner, [ STRING ]
business_type, {{business_type}}
city, {{city}}
company, {{company}}
country, {{country}}
country_code, {{country_code}}
email, {{email}}
first_name, {{first_name}}
form_name, {{form_name}}
form_type, {{form_type}}
g_click_id, {{g_click_id}}
ga_track_id, {{ga_track_id}}
general_opt_in, {{general_opt_in}}
language, {{language}}
last_name, {{last_name}}
page_source, {{page_source}}
phone, {{phone}}
product, {{product}}
state, {{state}}
state_code, {{state_code}}

Example Request
successfull request

View More
curl


curl --location -g '{{host}}/lead/activity' \
--header 'Content-Type: text/plain' \
--data 'affiliate_lead_id, {{affiliate_lead_id}}
affiliate_name, {{affiliate_name}}
business_type, {{business_type}}
campaign_content, {{campaign_content}}
campaign_medium, {{campaign_medium}}
campaign_name, {{campaign_name}}
campaign_source, {{campaign_source}}
city, {{city}}
company, {{company}}
country, {{country}}
country_code, {{country_code}}
email, {{email}}
first_name, {{first_name}}
form_detail, {{form_detail}}
form_name, {{form_name}}
form_type, {{form_type}}
g_click_id, {{g_click_id}}
ga_track_id, {{ga_track_id}}
general_opt_in, {{general_opt_in}}
language, {{language}}
last_name, {{last_name}}
page_source, {{page_source}}
partner, {{partner}}
phone, {{phone}}
product, {{product}}
state, {{state}}
state_code, {{state_code}}
autopilot_session_id, {{autopilot_session_id}}'

201 Created
Example Response
 * Body
 * Headers (3)

plain


message, created


Content-Type

text/plain

Date

Thu, 25 Apr 2019 18:43:49 GMT

Content-Length

17