Skip to main content
POST
Create a first person hired internationally 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 results list it creates. Must be unique across your agents: a name already in use is rejected with 409 LIST_NAME_TAKEN.

industries
string[]
required

Industry of the company. Use exact values from GET /business/agents/autocomplete?field=industry (for example "Software Development", "Financial Services"). Any other wording is first resolved to the closest supported LinkedIn industry ("tech" becomes "Technology, Information and Internet"), and a value with no match is dropped rather than rejected, so the filter silently widens instead of failing. Exactly one value is allowed here (min 1, max 1); to cover several, run one agent per value.

Required array length: 1 element
regions
string[]
required

Headquarters location of the company, as a LinkedIn geography: either a country ("United States") or a sub-national area ("California, United States"). Use exact values from GET /business/agents/autocomplete?field=region. The upstream stores the string as sent and never checks it against a list, so any other value is accepted, the create still answers 201, and the agent then silently matches nothing. Exactly one value is allowed here (min 1, max 1); to cover several, run one agent per value.

Required array length: 1 element
companyHeadcount
string[]
required

Size of the company, as a headcount bucket. Use one of exactly: 1-10, 11-50, 51-200, 201-500, 501-1,000, 1,001-5,000, 5,001-10,000, 10,001+ (the commas and the exact spacing are part of the value: "500-1000" is not a bucket). The upstream stores the string as sent and never checks it against a list, so any other value is accepted, the create still answers 201, and the agent then silently matches nothing. Exactly one value is allowed here (min 1, max 1); to cover several, run one agent per value.

Required array length: 1 element
start
boolean
default:false

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

companyHeadcountGrowth
object

Deprecated: accepted for backward compatibility and never forwarded to the provider, so arbitrary min and max values are allowed here and change nothing about what the agent matches. This monitor has no headcount-growth filter; constrain company size with companyHeadcount instead.

annualRevenue
object

Annual-revenue band of the company, in MILLIONS of USD: {"min": 1000, "max": 10000} means $1B to $10B. Both bounds are required whenever the object is sent, and subFilter must be one of exactly: USD, the default and the only currency the provider supports. Omit the whole object for no revenue filter.

expirationDate
string | null

Date the agent stops running, as YYYY-MM-DD (for example "2026-12-31"), and in the future. Pass null to run until you pause or delete it; omit it for the default of one month from creation.

maxContacts
integer

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

maxCreditSpend
integer

Maximum credits this agent may spend in a single run or refresh (1000 to 200000); delivery-driven monitors stop once their total delivered results reach it. Omit for no limit.

Required range: 1000 <= x <= 200000
notificationCount
integer

Maximum results the agent may deliver in a single run. Must be a positive multiple of 50.

Response

Success

agent
object
required