Create website site

curl --request POST \
  --url https://beta.getsales.io/signals/v1/api/website-sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "domain": "<string>",
  "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>",
  "key_pages": [
    {
      "key": "<string>",
      "label": "<string>",
      "pattern": "<string>",
      "is_conversion": true
    }
  ]
}
'

import requests

url = "https://beta.getsales.io/signals/v1/api/website-sites"

payload = {
    "domain": "<string>",
    "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>",
    "key_pages": [
        {
            "key": "<string>",
            "label": "<string>",
            "pattern": "<string>",
            "is_conversion": True
        }
    ]
}
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({
    domain: '<string>',
    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>',
    key_pages: [{key: '<string>', label: '<string>', pattern: '<string>', is_conversion: true}]
  })
};

fetch('https://beta.getsales.io/signals/v1/api/website-sites', 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",
  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([
    'domain' => '<string>',
    '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>',
    'key_pages' => [
        [
                'key' => '<string>',
                'label' => '<string>',
                'pattern' => '<string>',
                'is_conversion' => 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"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\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-sites")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/signals/v1/api/website-sites")

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  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "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>"
  },
  "already_exists": true,
  "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_sites

Create website site

Register a site for the website lane: a host or a URL (reduced to the bare host), its level (identification), the switches (link codes, the two carriers, consent, fingerprint, anonymize_ip, ignored addresses, the live alert level, the inbound table) and its key pages in the same call: key_pages absent = the default four (pricing, demo, signup, contact), [] = none. Ask the person first: explain the level (companies, the default: links carry the recipient’s company code and visits show the company, never a person; people: visits from the people the team writes to are shown by name), and that collecting consent from EU, EEA and UK visitors and saying so in their privacy policy is their own duty. Send confirm_identification true, which is required, only after they confirm. Born pending, no codes until verified. A host the team already registered is 409 duplicate_rejected. Not idempotent.

Contract:

MCP tool create_website_site, registry package mcp.signals/website_sites, mount signals.website.
Operation create, response envelope create.
Flags: none.

POST

api

website-sites

Create website site

curl --request POST \
  --url https://beta.getsales.io/signals/v1/api/website-sites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "domain": "<string>",
  "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>",
  "key_pages": [
    {
      "key": "<string>",
      "label": "<string>",
      "pattern": "<string>",
      "is_conversion": true
    }
  ]
}
'

import requests

url = "https://beta.getsales.io/signals/v1/api/website-sites"

payload = {
    "domain": "<string>",
    "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>",
    "key_pages": [
        {
            "key": "<string>",
            "label": "<string>",
            "pattern": "<string>",
            "is_conversion": True
        }
    ]
}
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({
    domain: '<string>',
    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>',
    key_pages: [{key: '<string>', label: '<string>', pattern: '<string>', is_conversion: true}]
  })
};

fetch('https://beta.getsales.io/signals/v1/api/website-sites', 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",
  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([
    'domain' => '<string>',
    '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>',
    'key_pages' => [
        [
                'key' => '<string>',
                'label' => '<string>',
                'pattern' => '<string>',
                'is_conversion' => 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"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\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-sites")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/signals/v1/api/website-sites")

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  \"domain\": \"<string>\",\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  \"key_pages\": [\n    {\n      \"key\": \"<string>\",\n      \"label\": \"<string>\",\n      \"pattern\": \"<string>\",\n      \"is_conversion\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "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>"
  },
  "already_exists": true,
  "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

Authorization

string

header

required

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-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_website_site.

domain

string

required

A host or a URL (acme.com, https://www.acme.com/pricing): reduced to the bare host. app.acme.com registers that host alone.

Maximum string length: 2048

confirm_identification

enum<boolean>

required

Required, true only after the person confirmed that, for the level chosen, collecting consent from visitors in the EU, the EEA and the UK and saying so in their privacy policy is their own duty. Stored as identification_confirmation.

Available options:

true

identification

enum<string>

What a visit may name: companies (default) or people. The person picks it once both are explained.

Available options:

companies,

people

include_subdomains

boolean

Hosts under the domain belong to the site. Default true.

link_codes_enabled

boolean

Code the links to this site (once it is verified and confirmed for its level, and while the team switch is on). Default true.

carrier_linkedin

enum<string>

Where the code rides in a LinkedIn link: fragment (default) or query.

Available options:

fragment,

query

carrier_email

enum<string>

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

fingerprint_mode

enum<string>

on (default), consent (only after consent) or off.

Available options:

on,

consent,

off

anonymize_ip

boolean

Keep a resolved session's address as its network part only. Default false.

ignored_ips

string[]

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: 50

live_alerts

enum<string>

off | key_pages (default) | all_known: when a known person on the site alerts the team now.

Available options:

off,

key_pages,

all_known

live_alert_tasks

boolean

A live alert also opens a task, due now, on the person's open threads. Default true; false sends the notice alone.

live_alert_task_minutes

integer | null

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 <= 43200

inbound_playtable_sid

string | null

The table an identified visitor nobody has would be handed to; stored only today. null clears it.

Required string length: 18

Pattern: ^pt_tb_

key_pages

object[] | null

The pages whose visits matter, created with the site in one transaction. Absent or null = the default four (pricing, demo, signup, contact, none a conversion); [] = none. At most 20.

Maximum array length: 20

Show child attributes

Response

create success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

create

item

object

required

Show child attributes

already_exists

boolean

required

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Create website site

Authorizations

Body

Response