Send a lead event
curl --request POST \
--url https://api.hi-doctor.ai/v1/users/meta/lead/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_id": "lead.browser-123",
"category_code": "p",
"consent": {
"marketing": true
},
"fbp": "fb.1.1558571054389",
"fbc": "fb.1.1558571054389iwp121Bof"
}
'import requests
url = "https://api.hi-doctor.ai/v1/users/meta/lead/"
payload = {
"event_id": "lead.browser-123",
"category_code": "p",
"consent": { "marketing": True },
"fbp": "fb.1.1558571054389",
"fbc": "fb.1.1558571054389iwp121Bof"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_id: 'lead.browser-123',
category_code: 'p',
consent: {marketing: true},
fbp: 'fb.1.1558571054389',
fbc: 'fb.1.1558571054389iwp121Bof'
})
};
fetch('https://api.hi-doctor.ai/v1/users/meta/lead/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hi-doctor.ai/v1/users/meta/lead/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_id' => 'lead.browser-123',
'category_code' => 'p',
'consent' => [
'marketing' => true
],
'fbp' => 'fb.1.1558571054389',
'fbc' => 'fb.1.1558571054389iwp121Bof'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hi-doctor.ai/v1/users/meta/lead/"
payload := strings.NewReader("{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hi-doctor.ai/v1/users/meta/lead/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hi-doctor.ai/v1/users/meta/lead/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}"
response = http.request(request)
puts response.read_body{
"event_id": "<string>",
"category_code": "p",
"consent": {
"marketing": true
},
"fbp": "<string>",
"fbc": "<string>"
}{
"accepted": true
}{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid"
}
]
}Attribution
Send a lead event
Anonymous attribution endpoint called by the landing funnel. Accepts a lead event for the current page category and returns 202; no bearer token is required, though an authenticated caller is matched by id. The event is only forwarded when consent.marketing is true — without marketing consent the request is still accepted (202) but nothing is sent.
category_code is a neutral single-letter code (p, c or s); event_id is a caller-supplied identifier used for de-duplication downstream (the endpoint itself does not enforce uniqueness). consent.marketing is required. Missing or invalid fields are a 400. The endpoint is throttled.
POST
/
v1
/
users
/
meta
/
lead
/
Send a lead event
curl --request POST \
--url https://api.hi-doctor.ai/v1/users/meta/lead/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_id": "lead.browser-123",
"category_code": "p",
"consent": {
"marketing": true
},
"fbp": "fb.1.1558571054389",
"fbc": "fb.1.1558571054389iwp121Bof"
}
'import requests
url = "https://api.hi-doctor.ai/v1/users/meta/lead/"
payload = {
"event_id": "lead.browser-123",
"category_code": "p",
"consent": { "marketing": True },
"fbp": "fb.1.1558571054389",
"fbc": "fb.1.1558571054389iwp121Bof"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
event_id: 'lead.browser-123',
category_code: 'p',
consent: {marketing: true},
fbp: 'fb.1.1558571054389',
fbc: 'fb.1.1558571054389iwp121Bof'
})
};
fetch('https://api.hi-doctor.ai/v1/users/meta/lead/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hi-doctor.ai/v1/users/meta/lead/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_id' => 'lead.browser-123',
'category_code' => 'p',
'consent' => [
'marketing' => true
],
'fbp' => 'fb.1.1558571054389',
'fbc' => 'fb.1.1558571054389iwp121Bof'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hi-doctor.ai/v1/users/meta/lead/"
payload := strings.NewReader("{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hi-doctor.ai/v1/users/meta/lead/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hi-doctor.ai/v1/users/meta/lead/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"lead.browser-123\",\n \"category_code\": \"p\",\n \"consent\": {\n \"marketing\": true\n },\n \"fbp\": \"fb.1.1558571054389\",\n \"fbc\": \"fb.1.1558571054389iwp121Bof\"\n}"
response = http.request(request)
puts response.read_body{
"event_id": "<string>",
"category_code": "p",
"consent": {
"marketing": true
},
"fbp": "<string>",
"fbc": "<string>"
}{
"accepted": true
}{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json