You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/tools/apollo.mdx
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,8 @@ Search Apollo
56
56
|`organization_names`| array | No | Company names to search within \(legacy filter\)|
57
57
|`organization_locations`| array | No | Headquarters locations of the people's current employer \(e.g., \['texas', 'tokyo', 'spain'\]\)|
58
58
|`q_organization_domains_list`| array | No | Employer domain names \(e.g., \["apollo.io", "microsoft.com"\]\) — up to 1,000, no www. or @ |
59
-
|`contact_email_status`| array | No | Email statuses to filter by: verified, unverified, likely to engage, unavailable |
59
+
|`organization_num_employees_ranges`| array | No | Employee count ranges for the person\'s current employer. Each entry is "min,max" \(e.g., \["1,10", "250,500", "10000,20000"\]\)|
60
+
|`contact_email_status`| array | No | Email statuses to filter by: "verified", "unverified", "likely to engage", "unavailable" |
60
61
|`q_keywords`| string | No | Keywords to search for |
61
62
|`page`| number | No | Page number for pagination, default 1 \(e.g., 1, 2, 3\)|
62
63
|`per_page`| number | No | Results per page, default 25, max 100 \(e.g., 25, 50, 100\)|
@@ -178,7 +179,7 @@ Enrich data for up to 10 organizations at once using Apollo
178
179
| Parameter | Type | Required | Description |
179
180
| --------- | ---- | -------- | ----------- |
180
181
|`apiKey`| string | Yes | Apollo API key |
181
-
|`organizations`| array | Yes | Array of organizations to enrich \(max 10\)|
182
+
|`organizations`| array | Yes | Array of organizations to enrich \(max 10\). Each item requires `name` and may include `domain`\(e.g., \[\{"name": "Example Corp", "domain": "example.com"\}\]\)|
182
183
183
184
#### Output
184
185
@@ -293,7 +294,7 @@ Create up to 100 contacts at once in your Apollo database. Supports deduplicatio
293
294
| Parameter | Type | Required | Description |
294
295
| --------- | ---- | -------- | ----------- |
295
296
|`apiKey`| string | Yes | Apollo API key \(master key required\)|
296
-
|`contacts`| array | Yes | Array of contacts to create \(max 100\). Each contact may include first_name, last_name, email, title, organization_name, owner_id, contact_stage_id, linkedin_url, phone_numbers, and contact_emails |
297
+
|`contacts`| array | Yes | Array of contacts to create \(max 100\). Each contact may include first_name, last_name, email, title, organization_name, account_id, owner_id, contact_stage_id, linkedin_url, phone \(single string\) or phone_numbers\(array of \{raw_number, position\}\), contact_emails, typed_custom_fields, and CRM IDs \(salesforce_contact_id, hubspot_id, team_id\) for cross-system matching|
297
298
|`append_label_names`| array | No | Label names to add to all contacts in this request \(e.g., \["Hot Lead"\]\)|
298
299
|`run_dedupe`| boolean | No | Enable deduplication to prevent creating duplicate contacts. When true, existing contacts are returned without modification |
299
300
@@ -419,9 +420,11 @@ Create up to 100 accounts at once in your Apollo database. Set run_dedupe=true t
419
420
| --------- | ---- | ----------- |
420
421
|`created_accounts`| json | Array of newly created accounts |
421
422
|`existing_accounts`| json | Array of existing accounts returned by Apollo \(when duplicates are detected\)|
422
-
|`total_submitted`| number | Total number of accounts in the response \(created + existing\)|
423
+
|`failed_accounts`| json | Array of accounts that failed to be created, with reasons for failure |
424
+
|`total_submitted`| number | Total number of accounts in the response \(created + existing + failed\)|
423
425
|`created`| number | Number of accounts successfully created |
424
426
|`existing`| number | Number of existing accounts found |
427
+
|`failed`| number | Number of accounts that failed to be created |
0 commit comments