Skip to main content
PATCH
Change what a table's LinkedIn watch may spend

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

What a watch may spend: change any of these; leave a field out to keep it.

enrich_new_rows
boolean | null

Whether the enrichment columns run on each person as they arrive.

people_per_day
integer | null

The new daily ceiling.

Required range: 1 <= x <= 1000
spend_limit
number | null

The new total limit, in credits.

Required range: 1 <= x <= 10000000

Response

Successful Response

A table's LinkedIn watch: where it stands and what it may spend.

ceiling_credits_per_day
number
required

The most one day can cost now: its people, plus every column that runs on a new person by itself.

credits_per_person
number
required
enrich_new_rows
boolean
required
id
string<uuid>
required
last_person_at
string<date-time> | null
required
notices
string[]
required

What to check about its filters, in our words.

paused_at
string<date-time> | null
required
people_added
integer
required
people_per_day
integer
required
people_today
integer
required

People added today (UTC).

people_waiting
integer
required

People it was sent that wait to be added, held by a pause or the daily ceiling.

record_type
enum<string>
required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks,
post_engagers,
profile_engagers,
page_engagers,
topic_mentions,
event_attendees,
search_results
spend_limit_credits
number
required
spent_credits
number
required

What it has charged for the people it added.

started_at
string<date-time>
required
status
enum<string>
required

starting while it is being set up, active while it adds people, paused (see pause_reason), stopped by a person, or failed when it could not start.

Available options:
starting,
active,
paused,
stopped,
failed
stopped_at
string<date-time> | null
required
table_id
string<uuid>
required
verified
boolean
required

Whether a test delivery proved people can reach this table.

events
LeadWatchEventSchema · object[]
failure_filter
string | null

The filter a refused start was pinned to.

failure_message
string | null

Why it could not start, in words to show.

funnel
LeadWatchFunnelSchema · object | null

Why the watch added fewer people than it found, as last counted (at most an hour old).

pause_reason
enum<string> | null

Why it is paused: person, credits, limit (its total limit is spent), table_full, table_trashed, our_side (paused on our side), platform (paused for everyone) or landing_failed. credits, our_side and platform resume by themselves; the rest need a person.

Available options:
person,
credits,
limit,
table_full,
table_trashed,
our_side,
platform,
landing_failed