Identify website visitor by email
curl --request POST \
--url https://beta.getsales.io/signals/v1/api/website-visitors/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"site_sid": "<string>",
"visitor_id": "<string>",
"email": "<string>",
"name": "<string>",
"company": "<string>",
"form": "<string>"
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-visitors/identify"
payload = {
"site_sid": "<string>",
"visitor_id": "<string>",
"email": "<string>",
"name": "<string>",
"company": "<string>",
"form": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
site_sid: '<string>',
visitor_id: '<string>',
email: '<string>',
name: '<string>',
company: '<string>',
form: '<string>'
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-visitors/identify', 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://beta.getsales.io/signals/v1/api/website-visitors/identify",
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([
'site_sid' => '<string>',
'visitor_id' => '<string>',
'email' => '<string>',
'name' => '<string>',
'company' => '<string>',
'form' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://beta.getsales.io/signals/v1/api/website-visitors/identify"
payload := strings.NewReader("{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://beta.getsales.io/signals/v1/api/website-visitors/identify")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-visitors/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"site_sid": "<string>",
"visitor_id": "<string>",
"is_ephemeral": true,
"person_sid": "<string>",
"identified_email": "<string>",
"bound_by": "code",
"bound_at": "<string>",
"first_seen_at": "<string>",
"last_seen_at": "<string>",
"sessions_count": 1,
"browser": "<string>",
"browser_version": "<string>",
"os": "<string>",
"os_version": "<string>",
"device": "desktop",
"screen": "<string>",
"language": "<string>",
"timezone": "<string>",
"geo_country": "<string>",
"geo_region": "<string>",
"geo_city": "<string>",
"network_type": "<string>",
"network_name": "<string>",
"network_domain": "<string>",
"asn": 123,
"as_name": "<string>",
"is_internal": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"result": {
"bound": true,
"person_sid": "<string>"
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}website_visitors
Identify website visitor by email
Name the person behind a browser from the customer’s own backend, after a login or a signup: the site, the first-party visitor id the page holds (_gs_vid), the email, and a form name when a form was submitted (it becomes the fact website_form_submitted of the open session). The person is found by email in the team’s tables; nobody matched leaves the email on the row as identified_email; an address on the team’s own site marks the visit internal; a visitor bound by a code or by hand keeps its person. On a site set to companies it names nobody: no bind, no identified_email, no fact, only the internal rule; the form still joins the session’s events. A visitor id the collector has not seen yet is 422 relation_not_found: retry in a few seconds. For an agent in the app, identify_website_visitor is the tool.
Contract:
- MCP tool
identify_website_visitor_by_email, registry packagemcp.signals/website_visitors, mountsignals.visits. - Operation
action, response envelopeaction. - Flags: none.
POST
/
api
/
website-visitors
/
identify
Identify website visitor by email
curl --request POST \
--url https://beta.getsales.io/signals/v1/api/website-visitors/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"site_sid": "<string>",
"visitor_id": "<string>",
"email": "<string>",
"name": "<string>",
"company": "<string>",
"form": "<string>"
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-visitors/identify"
payload = {
"site_sid": "<string>",
"visitor_id": "<string>",
"email": "<string>",
"name": "<string>",
"company": "<string>",
"form": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
site_sid: '<string>',
visitor_id: '<string>',
email: '<string>',
name: '<string>',
company: '<string>',
form: '<string>'
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-visitors/identify', 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://beta.getsales.io/signals/v1/api/website-visitors/identify",
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([
'site_sid' => '<string>',
'visitor_id' => '<string>',
'email' => '<string>',
'name' => '<string>',
'company' => '<string>',
'form' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://beta.getsales.io/signals/v1/api/website-visitors/identify"
payload := strings.NewReader("{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://beta.getsales.io/signals/v1/api/website-visitors/identify")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-visitors/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_sid\": \"<string>\",\n \"visitor_id\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"form\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"site_sid": "<string>",
"visitor_id": "<string>",
"is_ephemeral": true,
"person_sid": "<string>",
"identified_email": "<string>",
"bound_by": "code",
"bound_at": "<string>",
"first_seen_at": "<string>",
"last_seen_at": "<string>",
"sessions_count": 1,
"browser": "<string>",
"browser_version": "<string>",
"os": "<string>",
"os_version": "<string>",
"device": "desktop",
"screen": "<string>",
"language": "<string>",
"timezone": "<string>",
"geo_country": "<string>",
"geo_region": "<string>",
"geo_city": "<string>",
"network_type": "<string>",
"network_name": "<string>",
"network_domain": "<string>",
"asn": 123,
"as_name": "<string>",
"is_internal": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"result": {
"bound": true,
"person_sid": "<string>"
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of identify_website_visitor_by_email.
The site the page belongs to.
Required string length:
18Pattern:
^sg_si_The first-party visitor id the page holds (_gs_vid), as the customer's backend read it from the browser.
Maximum string length:
64The address the person logged in or signed up with; the person is found by it in the team's tables.
Maximum string length:
320Taken as the script's identify takes it; not stored until the inbound lead slice.
Maximum string length:
200Taken as the script's identify takes it; not stored until the inbound lead slice.
Maximum string length:
200The form the person submitted (signup): it joins the open session's events once per name and becomes the fact website_form_submitted.
Pattern:
^[A-Za-z0-9_.:-]{1,64}$Response
action success envelope.
Available options:
true Available options:
action kebab-case verb; matches the route segment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes