Skip to main content
POST
Create a job changes watcher agent

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json
listName
string
required

Name for BOTH the agent and the NEW dedicated results list this watcher creates. Must be unique — never reuse a source list's name; name it after the agent the user is creating.

Minimum string length: 1
start
boolean
default:false

true creates AND activates the agent (spends credits); false (default) saves a draft to activate later.

listId
string

The existing SOURCE list(s) to watch, by id — the people/companies whose changes are tracked.

Minimum string length: 1
listIds
string[]

The existing SOURCE list(s) to watch, by id: the people whose changes are tracked. Each id is a list id from GET /business/lists. Every list you name is watched and their members are unioned, and there is no cap on how many lists; listIds and listId are mutually exclusive (sending both is rejected). Unlike the people and companies watchers, this one REJECTS a repeated id rather than collapsing it (422 VALIDATION_FAILED, "listIds must not contain duplicate list IDs"), so name each list once. Only shared contacts with a LinkedIn URL are watched, so custom contacts are skipped; source lists holding none of them are rejected when the agent starts (422 AGENT_SOURCE_LIST_EMPTY).

Minimum array length: 1
Minimum string length: 1
frequency
enum<integer>
default:30

How often each watched contact is re-checked, in days: 30 (monthly, the default), 7 (weekly) or 1 (daily). Every check costs 50 credits per watched contact, so this is also the billing cadence.

Available options:
30,
7,
1
maxContacts
integer

Cap on the total number of results this agent delivers into its list. Omit for no cap.

maxCreditSpend
integer

Maximum credits one check may cost (1000 to 200000): the watcher watches at most maxCreditSpend / 50 contacts, and the contacts already watched keep their place. Omit for no limit.

Required range: 1000 <= x <= 200000
enrichPhone
boolean
default:false

Also enrich every delivered contact with a phone number. Costs additional credits per contact enriched.

enrichEmail
boolean
default:false

Also enrich every delivered contact with a work email address. Costs additional credits per contact enriched.

Response

Success

agent
object
required