Update website site
curl --request PATCH \
--url https://beta.getsales.io/signals/v1/api/website-sites/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"confirm_identification": true,
"include_subdomains": true,
"link_codes_enabled": true,
"anonymize_ip": true,
"ignored_ips": [
"<string>"
],
"live_alert_tasks": true,
"live_alert_task_minutes": 21602,
"inbound_playtable_sid": "<string>",
"enabled": true
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-sites/{sid}"
payload = {
"confirm_identification": True,
"include_subdomains": True,
"link_codes_enabled": True,
"anonymize_ip": True,
"ignored_ips": ["<string>"],
"live_alert_tasks": True,
"live_alert_task_minutes": 21602,
"inbound_playtable_sid": "<string>",
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
confirm_identification: true,
include_subdomains: true,
link_codes_enabled: true,
anonymize_ip: true,
ignored_ips: ['<string>'],
live_alert_tasks: true,
live_alert_task_minutes: 21602,
inbound_playtable_sid: '<string>',
enabled: true
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-sites/{sid}', 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-sites/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'confirm_identification' => true,
'include_subdomains' => true,
'link_codes_enabled' => true,
'anonymize_ip' => true,
'ignored_ips' => [
'<string>'
],
'live_alert_tasks' => true,
'live_alert_task_minutes' => 21602,
'inbound_playtable_sid' => '<string>',
'enabled' => true
]),
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-sites/{sid}"
payload := strings.NewReader("{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/signals/v1/api/website-sites/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-sites/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"domain": "<string>",
"include_subdomains": true,
"site_key": "<string>",
"status": "pending",
"verified_at": "<string>",
"last_check_at": "<string>",
"last_check_result": {
"outcome": "found",
"pages": [
{
"url": "<string>",
"key_page_sid": "<string>",
"outcome": "found",
"http_status": 123,
"failure": "invalid_url"
}
]
},
"broken_reason": "loader_missing",
"last_hit_at": "<string>",
"hits_count_24h": 1,
"identification": "companies",
"identification_confirmation": {
"identification": "companies",
"confirmed_at": "<string>",
"confirmed_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
}
},
"link_codes_enabled": true,
"carrier_linkedin": "fragment",
"carrier_email": "fragment",
"consent_mode": "not_required",
"fingerprint_mode": "on",
"anonymize_ip": true,
"ignored_ips": [
"<string>"
],
"live_alerts": "off",
"live_alert_tasks": true,
"live_alert_task_minutes": 123,
"inbound_playtable_sid": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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_sites
Update website site
Change a site’s settings: identification, include_subdomains, link_codes_enabled (this site only; team-wide: update_signal_settings), carrier_linkedin and carrier_email (fragment or query), consent_mode, fingerprint_mode, anonymize_ip, ignored_ips (replaced whole), live_alerts, live_alert_tasks, live_alert_task_minutes, inbound_playtable_sid; enabled false switches the site off, true brings it back as verified or pending. A switch to people needs confirm_identification true in the same call (else 422 confirmation_required): first tell the person that visits from the people the team writes to will be shown by name and that collecting consent from EU, EEA and UK visitors and saying so in their privacy policy is their own duty, and send it only after they confirm. A switch to companies (visits show the company, never a person) needs none. confirm_identification true alone records a confirmation for the current level. domain and site_key are not editable (rotate_website_site_key mints a key). Nothing changed is 422 nothing_to_update.
Contract:
- MCP tool
update_website_site, registry packagemcp.signals/website_sites, mountsignals.website. - Operation
update, response envelopeupdate. - Flags: none.
PATCH
/
api
/
website-sites
/
{sid}
Update website site
curl --request PATCH \
--url https://beta.getsales.io/signals/v1/api/website-sites/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"confirm_identification": true,
"include_subdomains": true,
"link_codes_enabled": true,
"anonymize_ip": true,
"ignored_ips": [
"<string>"
],
"live_alert_tasks": true,
"live_alert_task_minutes": 21602,
"inbound_playtable_sid": "<string>",
"enabled": true
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-sites/{sid}"
payload = {
"confirm_identification": True,
"include_subdomains": True,
"link_codes_enabled": True,
"anonymize_ip": True,
"ignored_ips": ["<string>"],
"live_alert_tasks": True,
"live_alert_task_minutes": 21602,
"inbound_playtable_sid": "<string>",
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
confirm_identification: true,
include_subdomains: true,
link_codes_enabled: true,
anonymize_ip: true,
ignored_ips: ['<string>'],
live_alert_tasks: true,
live_alert_task_minutes: 21602,
inbound_playtable_sid: '<string>',
enabled: true
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-sites/{sid}', 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-sites/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'confirm_identification' => true,
'include_subdomains' => true,
'link_codes_enabled' => true,
'anonymize_ip' => true,
'ignored_ips' => [
'<string>'
],
'live_alert_tasks' => true,
'live_alert_task_minutes' => 21602,
'inbound_playtable_sid' => '<string>',
'enabled' => true
]),
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-sites/{sid}"
payload := strings.NewReader("{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/signals/v1/api/website-sites/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-sites/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirm_identification\": true,\n \"include_subdomains\": true,\n \"link_codes_enabled\": true,\n \"anonymize_ip\": true,\n \"ignored_ips\": [\n \"<string>\"\n ],\n \"live_alert_tasks\": true,\n \"live_alert_task_minutes\": 21602,\n \"inbound_playtable_sid\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"domain": "<string>",
"include_subdomains": true,
"site_key": "<string>",
"status": "pending",
"verified_at": "<string>",
"last_check_at": "<string>",
"last_check_result": {
"outcome": "found",
"pages": [
{
"url": "<string>",
"key_page_sid": "<string>",
"outcome": "found",
"http_status": 123,
"failure": "invalid_url"
}
]
},
"broken_reason": "loader_missing",
"last_hit_at": "<string>",
"hits_count_24h": 1,
"identification": "companies",
"identification_confirmation": {
"identification": "companies",
"confirmed_at": "<string>",
"confirmed_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
}
},
"link_codes_enabled": true,
"carrier_linkedin": "fragment",
"carrier_email": "fragment",
"consent_mode": "not_required",
"fingerprint_mode": "on",
"anonymize_ip": true,
"ignored_ips": [
"<string>"
],
"live_alerts": "off",
"live_alert_tasks": true,
"live_alert_task_minutes": 123,
"inbound_playtable_sid": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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.
Path Parameters
Website site sid (sg_si_...).
Required string length:
18Pattern:
^sg_si_Body
application/json
Request body of update_website_site.
companies or people. A switch to people needs confirm_identification true in the same call; a switch to companies needs none and keeps the stored confirmation.
Available options:
companies, people true only after the person confirmed the customer's duties for the level the site ends at: stored as identification_confirmation, also on its own (a site with none gets no codes). false is the same as leaving it out.
Hosts under the domain belong to the site. Default true.
Code the links to this site (once it is verified and confirmed for its level, and while the team switch is on). Default true.
Where the code rides in a LinkedIn link: fragment (default) or query.
Available options:
fragment, query Where the code rides in an email link: query (default) or fragment.
Available options:
fragment, query not_required (default) stores the visitor id on the first hit; required waits for the site's banner to call gs('consent', true).
Available options:
not_required, required on (default), consent (only after consent) or off.
Available options:
on, consent, off Keep a resolved session's address as its network part only. Default false.
IPv4 or IPv6 addresses or CIDR ranges of internal traffic (the office, the VPN). Replaced whole; at most 50; an entry that is neither is 422 invalid_ip.
Maximum array length:
50off | key_pages (default) | all_known: when a known person on the site alerts the team now.
Available options:
off, key_pages, all_known A live alert also opens a task, due now, on the person's open threads. Default true; false sends the notice alone.
The life of that task in minutes, 5 to 43200 (30 days): still open by then, the sweep cancels it. null = it never expires. Default 30.
Required range:
5 <= x <= 43200The table an identified visitor nobody has would be handed to; stored only today. null clears it.
Required string length:
18Pattern:
^pt_tb_false switches the site off (status disabled: hits dropped, no codes); true brings it back as verified when it had been verified and was not broken, else as pending. Already in that state changes nothing.
Response
update success envelope.
Available options:
true Available options:
update Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.