Contents

API reference / Accounts

Change a target account

PATCH /api/v1/accounts/{account}

update_account Write MCP tool

Edit the name, one-liner, origins, competitors, category phrases, pause or resume scanning, or set the company type yourself. Competitors and phrases you set are never replaced by what the site says. A change to competitors or phrases takes effect at the next scan (scan_account asks for one).

A full-access key (ss_sk_…), or an editor or owner signed in.

Parameters

NameTypeDescription
account required
path
string The account's id.

Request body

JSON, sent with Content-Type: application/json.

NameTypeDescription
name string
1–80 characters
The company's name.
one_liner string
up to 240 characters
What it does, in one line.
origins array of string The lists it came from (replaces the current ones).
competitors array of string Competitors to listen for, up to five (replaces the current ones; the first three are scanned).
phrases array of string Category phrases people use to look for what it sells, up to five (replaces the current ones).
paused boolean true stops scanning it; false resumes.
company_type string or null Your own call on the company: business, hobby (a hobby, student or consumer project) or null to let the AI decide again.
One of: business hobby

Returns

{ data: Account }

Example

curl -X PATCH "https://sniffington.com/api/v1/accounts/{account}" \
  -H "Authorization: Bearer $SCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme","one_liner":"…"}'