Update an engagement watch
Reconfigure a watch. This is a full replace of the changeable fields, not a patch: send the whole intended state, because an omitted optional field falls back to its default rather than keeping its current value.
kind, keywords and company_linkedin_id cannot be changed. Set is_enabled: false to stop sweeping and stop spending without losing the watch or anything it has collected.
Authorizations
Account API key passed in the Authorization header
Path Parameters
Query Parameters
Target account UUID. Required for staff callers; ignored for customer API keys.
Body
Response
OK
ISO 3166-1 alpha-2 codes to keep. Empty means no country restriction.
A disabled watch is not swept and costs nothing, but keeps its history.
topic or company.
"topic"
Cost dial: how many engagers are read per post. Spend per sweep is this times max_posts_per_sweep.
Cost dial: how many posts one sweep will look at.
Your label for this watch.
"Lean manufacturing"
Personas that decide which engagers count as leads. Empty keeps everyone who engaged.
Company watches only: the competitor's numeric LinkedIn ID.
Topic watches only: the boolean query, exactly as you wrote it.
How many people the last run collected. Zero after a completed sweep means nobody engaged, which is different from the watch not having run.
What the last run did. One of:
- completed: it ran, and last_sweep_engagers_collected says what it found. Zero is a real answer.
- out_of_credits: skipped before spending, because the account could not pay for a single person. This is the one to check when a feed goes quiet — topping up resumes it on the next sweep.
- failed: it ran and something went wrong, usually the provider. Self-correcting, since the next sweep re-reads an overlapping window.
When this watch last ran. Absent until its first sweep.