GEgetsales
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 package mcp.signals/website_sites, mount signals.website.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/website-sites/{sid}

Request

  • Base URL
    https://beta.getsales.io/signals/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Website site sid (sg_si_...).

Request body

identification'companies' | 'people'

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.

confirm_identificationboolean

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.

include_subdomainsboolean

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

link_codes_enabledboolean

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'fragment' | 'query'

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

carrier_email'fragment' | 'query'

Where the code rides in an email link: query (default) or fragment.

consent_mode'not_required' | 'required'

not_required (default) stores the visitor id on the first hit; required waits for the site's banner to call gs('consent', true).

fingerprint_mode'on' | 'consent' | 'off'

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

anonymize_ipboolean

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

ignored_ipsstring[]

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.

live_alerts'off' | 'key_pages' | 'all_known'

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

live_alert_tasksboolean

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_minutesinteger nullable

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.

inbound_playtable_sidstring nullable

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

enabledboolean

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.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

No recorded changes to this operation across all 1 revision of this API.