Skip to main content
Apollo logo
  • Category: people & contact data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 72
  • Triggers: 0
  • Slug: APOLLO
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Frequently Asked Questions

Apollo API keys can be limited to specific endpoint groups. A tool can return HTTP 403 or Forbidden when the underlying Apollo API rejects the key for that operation, even if the same key works for other Apollo tools.This can affect gated search, enrichment, usage, and outreach tools such as APOLLO_PEOPLE_SEARCH, APOLLO_ORGANIZATION_SEARCH, APOLLO_SEARCH_ACCOUNTS, APOLLO_SEARCH_OUTREACH_EMAILS, APOLLO_PEOPLE_ENRICHMENT, APOLLO_BULK_PEOPLE_ENRICHMENT, APOLLO_ORGANIZATION_ENRICHMENT, APOLLO_BULK_ORGANIZATION_ENRICHMENT, and APOLLO_VIEW_API_USAGE_STATS.In Apollo, make sure the API key has access to the relevant endpoint group or has Set as master key turned on. If the Apollo plan does not include the requested API feature, the tool can still return 403 until that access is enabled in Apollo.

Tools

Slug: APOLLO_ACTIVATE_SEQUENCEActivate an inactive Apollo sequence and begin its scheduled outreach. Activation allows Apollo to send emails externally to enrolled contacts according to the sequence’s configured steps and schedule. Reference: https://docs.apollo.io/reference/approve-sequence

Input Parameters

string
required
Apollo ID of the inactive sequence to activate. The sequence must contain at least one step.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_ADD_CONTACTS_TO_SEQUENCEAdds contacts to a specified Apollo email sequence and returns the contact details. sequence_id, emailer_campaign_id, and send_email_from_email_account_id must be retrieved from Apollo listing/search endpoints before calling this tool — these IDs cannot be inferred from names.

Input Parameters

string
Optional unique ID of the user performing the action (in request body if specified).
array
required
List of unique Apollo contact IDs to add to the sequence (in request body).
string
required
Unique ID of the Apollo sequence to add contacts to (path parameter).
boolean
If true, add contacts without an email address (query parameter).
string
required
Unique ID of the Apollo emailer campaign (should match sequence_id; in request body).
boolean
If true, add contacts who recently changed jobs (query parameter).
boolean
If true, add contacts with unverified emails (query parameter).
string
required
Unique ID of the Apollo email account for sending emails (in request body).
boolean
If true, add contacts active in other sequences (query parameter).
boolean
If true, add contacts finished in other sequences (query parameter).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_ADD_PEOPLE_TO_PROSPECTSSave Apollo person IDs returned by APOLLO_PEOPLE_SEARCH as persistent prospect contacts. Unlike APOLLO_CREATE_CONTACT, this converts existing Apollo search results instead of creating a contact from caller-supplied attributes. Requires a paid Apollo plan. Apollo can also create an associated account record, which its API cannot delete; obtain explicit user confirmation before execution.

Input Parameters

array
required
Non-empty list of Apollo person IDs returned by APOLLO_PEOPLE_SEARCH to save as persistent prospect contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_ARCHIVE_SEQUENCEArchive an Apollo sequence, making it inactive and finishing all enrolled contacts. This lifecycle change can end outreach for every contact currently in the sequence. The caller must own the sequence or have full-access sharing permission. Reference: https://docs.apollo.io/reference/archive-sequence

Input Parameters

string
required
Apollo ID of the sequence to archive. Archiving makes the sequence inactive and finishes all contacts currently enrolled in it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_BULK_ORGANIZATION_ENRICHMENTEnriches data for up to 10 organizations simultaneously by providing a list of their base company domains (e.g., ‘apollo.io’, not ‘www.apollo.io’). Charged per domain enriched.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per organization enriched in the batch

Input Parameters

array
required
List of 1-10 company domains to enrich. Domains should be base domains (e.g., ‘apollo.io’) and not include ‘www.’, ’@’, or protocols like ‘http://’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_BULK_PEOPLE_ENRICHMENTEnriches up to 10 person profiles from Apollo’s database; charges may apply per person enriched, and unmatched entries may be null. Managed calls support base enrichment only and reject personal email or phone reveal and webhook delivery.Instant: Supported on the latest version.Instant pricing: $0.02–$0.18 per person enriched; waterfall may cost more.

Input Parameters

array
required
List of 1-10 person objects to enrich. At least one person is required. For effective matching, include key identifiers like email, LinkedIn URL, or name plus company information. Exceeding 10 objects causes 400/422 errors; chunk larger lists into batches of ≤10.
string
Webhook URL for phone number delivery if reveal_phone_number is true; mandatory in that case. URL must be publicly reachable; inaccessible URLs silently prevent phone data delivery.
boolean
If true, enriches with all available phone numbers; increases the price and requires ‘webhook_url’.
boolean
If true, enriches with personal emails; increases the price.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_BULK_UPDATE_ACCOUNT_STAGEBulk updates the stage for specified existing Apollo.io accounts, moving them to a valid new account stage.

Input Parameters

array
required
A list of unique identifiers for accounts whose stage needs to be updated.
string
required
The unique identifier of the account stage to which the specified accounts will be moved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_COMPLETE_TASKRequests completion of an Apollo task and returns the resulting task state. Check the returned state: Apollo can return a deleted task with HTTP 200.

Input Parameters

string
required
The Apollo ID of the task to mark as completed. Use the Search Tasks action to find task IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_ACCOUNTCreates a new account in Apollo.io; a new record is created even if a similar account exists, and provided owner_id or account_stage_id must be valid existing IDs. The response includes the new account’s ID, which can be used directly in subsequent calls.

Input Parameters

string
required
Human-readable name for the account.
string
Primary phone number for the account (e.g., main corporate line, branch, or direct dial).
string
Company’s primary domain name (e.g., ‘apollo.io’, not ‘www.apollo.io’) to help Apollo enrich account data.
string
Unique ID of the user within your Apollo team to be assigned as owner; retrieve via the ‘Get a List of Users’ endpoint.
string
Physical address or general location of the account (e.g., full street address or ‘City, State, Country’).
string
Unique ID for the account’s sales stage (e.g., ‘Prospecting’ or ‘Closed Won’); retrieve via the ‘List Account Stages’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_BULK_ACCOUNTSCreates multiple accounts in Apollo.io with a single API call (maximum 100 accounts per request). Use when creating multiple company records at once.

Input Parameters

array
required
Array of account objects to create (maximum 100 accounts per request). Each account should have at least a name or domain.
boolean
Enable aggressive deduplication by domain, organization_id, and name. When false (default), only matches by CRM IDs. When true, also matches by domain, organization_id, and name. Existing accounts are returned without modification in both modes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_BULK_CONTACTSTool to bulk create multiple contacts in Apollo with a single API call. Use when you need to create multiple contacts efficiently. Supports up to 100 contacts per request with optional deduplication.

Input Parameters

array
required
Array of contact objects to create. Maximum 100 contacts per request. Each contact should have at least first_name, last_name, or email.
boolean
Enable full deduplication across all sources. When false (default), creates duplicates for non-email_import sources and merges with email_import placeholders only. When true, returns existing contacts without modifying them (except email_import placeholders which are still merged). Matches by email, CRM IDs, or name + organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_CALL_RECORDTool to log call records in Apollo from external systems. Use when recording calls made through outside systems like Orum or Nooks; requires a master API key and cannot dial prospects directly.

Input Parameters

string
Add a note to the call record.
boolean
Set to true if you want to create an individual record for the phone call in Apollo.
string ("queued" | "ringing" | "in-progress" | "completed" | "no_answer" | "failed" | "busy")
Possible status values for a phone call.
array
Designate the caller in your team’s Apollo account. Use the Get a List of Users endpoint to retrieve IDs for all of the users within your Apollo account.
integer
The duration of the call in seconds. Do not enter minutes.
string
The time when the call ended. Should adhere to the ISO 8601 date-time format. Apollo uses GMT by default. You can adjust the time manually by specifying in hours and minutes how much you want to offset GMT.
string
The phone number that you dialed.
string
Associate the call with an account. Use the Search for Accounts endpoint to retrieve IDs for all of the accounts within your Apollo account.
string
Designate the contact that was called. Use the Search for Contacts endpoint to retrieve IDs for all of the contacts within your Apollo account.
string
The time when the call started. Should adhere to the ISO 8601 date-time format. Apollo uses GMT by default. You can adjust the time manually by specifying in hours and minutes how much you want to offset GMT.
string
The phone number that dialed you.
string
Assign a call outcome to the record. Call outcomes are unique to your team’s Apollo account. When you use the Disposition search filter for calls in the Apollo product, you can find the corresponding call outcome ID in the URL.
string
Assign a call purpose to the record. Call purposes are unique to your team’s Apollo account. When you use the Purpose search filter for calls in the Apollo product, you can find the corresponding call purpose ID in the URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_CONTACTCreates a new contact in Apollo.io; use account_id to link to an organization and contact_stage_id for sales stage. Apollo does not auto-deduplicate — duplicate records sharing the same email are silently created; always search via APOLLO_SEARCH_CONTACTS before calling this tool. Requires explicit user confirmation before execution.

Input Parameters

string
The primary email address for the contact.
string
The contact’s current job title.
string
required
Last name of the contact.
string
Apollo ID of the organization to assign this contact; obtain via ‘Organization Search’ (usually the id field).
string
required
First name of the contact.
string
Home phone number. Apollo attempts to parse/sanitize format.
array
Descriptive labels to categorize the contact; new labels create new lists in Apollo. Validate values against existing Apollo labels via APOLLO_GET_LABELS before use; unrecognized or mismatched values can cause request failures.
string
Alternative or unspecified-type phone number. Apollo attempts to parse/sanitize format.
string
Full corporate website URL for the contact’s employer (e.g., ‘https://www.apollo.io/’); must be an official company site, not social media.
string
Primary direct dial phone number. Apollo attempts to parse/sanitize format.
string
Mobile phone number. Apollo attempts to parse/sanitize format.
string
Work or office direct line. Apollo attempts to parse/sanitize format.
string
Apollo ID for the contact’s sales/engagement stage (e.g., representing ‘Approaching’); obtain via an action listing contact stages.
string
Name of the contact’s current organization. Use ‘Organization Search’ for the exact Apollo-recognized name for best results.
string
Contact’s current location as a single string (e.g., ‘Atlanta, United States’, ‘Tokyo, Japan’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_CUSTOM_FIELDCreates a new custom field in Apollo.io for contacts, accounts, or opportunities. Use when you need to define additional data fields beyond Apollo’s standard attributes.

Input Parameters

object
Optional metadata for the custom field.
string ("string" | "textarea" | "number" | "date" | "datetime" | "boolean")
required
Type of the custom field that determines what kind of data it can store.
string
required
Name/label for the custom field you want to create in Apollo.
string ("contact" | "account" | "opportunity")
Enum for custom field modality (which object type the field applies to).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_DEALCreates a new sales opportunity (deal) in Apollo.io; all provided IDs (owner_id, account_id, opportunity_stage_id) must be valid existing Apollo identifiers. This action has persistent side effects — obtain explicit user confirmation before invoking.

Input Parameters

string
required
Human-readable name for the new deal.
string
Monetary value (string of numbers only, e.g., ‘50000’, no symbols/commas). Currency is based on Apollo account settings.
string
Unique identifier of the Apollo user owning this deal. Retrieve via ‘Get a List of Users’ endpoint.
string
Unique identifier of the Apollo account (company) for this deal. Find via ‘Organization Search’ endpoint.
string
Anticipated deal closing date (YYYY-MM-DD).
string
Unique identifier for the deal’s sales pipeline stage (e.g., ‘Prospecting’). Retrieve via ‘List Deal Stages’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_EMAIL_DRAFTCreate an unsent Apollo outreach draft, or return the existing draft already linked to outreach_task_id.

Input Parameters

string
Subject line for the draft.
string
HTML body, which Apollo sanitizes before saving.
string
Apollo ID of the contact receiving the draft. Required unless replying to an existing message.
array
To, cc, and bcc recipients for the draft.
array
Apollo attachment IDs to include with the draft.
boolean
Whether to enable permitted open and click tracking.
string
Apollo outreach task ID to associate with the draft. If that task already has a drafted email, Apollo returns and links the existing draft instead of creating another.
string
Apollo email template ID to associate with the draft.
string
Apollo email message ID to reply to; Apollo infers the contact and recipients from it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_SEQUENCECreate an Apollo outreach sequence, optionally including steps and email variants.

Input Parameters

string
required
Human-readable name for the sequence.
boolean
Whether to activate the sequence immediately. Inactive sequences do not send steps.
string
Apollo ID of the folder in which to place the sequence.
array
List names to apply to the sequence. Apollo creates labels that do not exist.
array
Ordered sequence steps and their email variants.
boolean
Whether to pause a contact when Apollo detects an out-of-office reply.
integer
Maximum number of emails the sequence sends per day. Must not be negative.
string
Apollo ID of the non-empty team schedule controlling email send days and times.
string
Apollo ID of an existing ruleset whose shared settings should apply.
boolean
Whether to finish a contact in the sequence after an email link click.
boolean
Whether to finish a contact in the sequence after an email reply.
boolean
Whether to create a task after a contact reaches the email-open threshold.
boolean
Whether every step uses exact_datetime instead of relative wait fields.
array
Team account-stage IDs excluded from the sequence.
array
Team contact-stage IDs excluded from the sequence.
boolean
Whether to finish a contact in the sequence when marked interested.
integer
Days to pause other contacts at the same account after a reply, up to 1000.
integer
Number of email opens that triggers task creation.
integer
Days after which an incoming email is no longer treated as a sequence response.
boolean
Whether to send to contacts on Apollo’s global email bounce list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_SEQUENCE_STEPCreate one step at a specified position in an existing Apollo outreach sequence.

Input Parameters

string
Instructions or context for the new step.
string ("auto_email" | "manual_email" | "call" | "action_item" | "linkedin_step_connect" | "linkedin_step_message" | "linkedin_step_view_profile" | "linkedin_step_interact_post")
required
Sequence step type supported by Apollo.
integer
required
One-based position for the new step in the sequence.
string ("high" | "medium" | "low")
Task priority. Not applicable to auto-email steps.
string ("minute" | "hour" | "day")
Unit for wait_time. Provide with wait_time for relative scheduling; omit for an exact-datetime sequence.
integer
Delay after the preceding step, measured in wait_mode units. Provide with wait_mode for relative scheduling; omit for an exact-datetime sequence.
string
required
Apollo ID of the existing sequence that receives the step.
string
Future ISO 8601 execution time for exact-datetime sequences.
integer
Maximum emails this step may send per day. Must not be negative.
integer
Days after which an incomplete task step is skipped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_CREATE_TASKTool to create a single task in Apollo.io. Use when you need to add a new task to your team’s Apollo account for a specific contact. The task will be assigned to a user and includes details like type, status, priority, due date, and optional notes.

Input Parameters

string
Add a description for the task. This should be a human-readable message. This parameter is not required, but it is recommended as it provides the task owner with more context on the action they need to take.
string ("call" | "outreach_manual_email" | "linkedin_step_connect" | "linkedin_step_message" | "linkedin_step_view_profile" | "linkedin_step_interact_post" | "action_item")
required
Set the task to be one of the following task types. This enables the task owner to know the type of action they need to take: ‘call’ (Call the contact), ‘outreach_manual_email’ (Email the contact), ‘linkedin_step_connect’ (Send a LinkedIn invitation), ‘linkedin_step_message’ (Send a LinkedIn message), ‘linkedin_step_view_profile’ (View LinkedIn profile), ‘linkedin_step_interact_post’ (Interact with LinkedIn posts), ‘action_item’ (Generic action - recommended to use with note parameter).
string
A title for the task. If omitted, Apollo will display an auto-generated title based on the task type and contact name.
string
required
The full date and time when the task will be due. Your entry should adhere to the ISO 8601 date-time format. Apollo uses Greenwich Mean Time (GMT) by default. If you do not account for time zone differences, you could add a task due date that falls on a different day than you intended. The value you enter can either adhere to GMT, or you can adjust the time manually by specifying in hours and minutes how much you want to offset GMT.
string ("scheduled" | "completed" | "skipped")
required
The status of the task being created. For future-facing tasks, use ‘scheduled’. For tasks that are already completed, use ‘completed’ or ‘skipped’.
string
required
The ID for the task owner within your team’s Apollo account. This is the user that will take action on the contact. Use the ‘Get a List of Users’ endpoint to retrieve IDs for all users within your Apollo account.
string ("high" | "medium" | "low")
Valid priority levels for tasks
string
required
The Apollo ID for the contact that you want to be on the receiving end of the action. To find contact IDs, call the ‘Search for Contacts’ endpoint and identify the ‘id’ value for the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_DEACTIVATE_SEQUENCEDeactivate an active Apollo sequence. Deactivation pauses all enrolled contacts and stops scheduled email sends. Reference: https://docs.apollo.io/reference/abort-sequence

Input Parameters

string
required
Apollo ID of the active sequence to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_EXPORT_CONVERSATIONSStart an asynchronous gzipped JSON conversation export and email a team member when it is ready. Each exported conversation with AI insights costs 1 credit; conversations without AI insights are free. Free plans allow one export request per minute and 20 per hour.

Input Parameters

string
required
Email address of a valid Apollo team member. Apollo emails this person when the asynchronous export is ready.
string
required
End of the export range as an ISO 8601 timestamp in GMT. Must be later than start_time.
string
required
Start of the export range as an ISO 8601 timestamp in GMT. Must be earlier than end_time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_ACCOUNTTool to retrieve detailed information about a specific account by its Apollo ID. Use when you need to fetch complete account data including company details, contact information, and CRM integration fields.

Input Parameters

string
required
The Apollo ID for the account that you want to retrieve. To find account IDs, call the Search for Accounts endpoint and identify the id value for the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_AUTH_STATUSTool to check whether the provided Apollo API key is valid and accepted by Apollo (health/auth check).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_CONTACTRetrieves detailed information about a specific contact by its ID. Use this to view contact details including name, email, phone numbers, organization, and custom fields.

Input Parameters

string
required
The Apollo ID for the contact that you want to view. To find contact IDs, call the Search for Contacts action and identify the ‘id’ value for the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_CONVERSATIONRetrieve full Apollo conversation details, including transcript, participants, recordings, and opportunities. Charged only when AI insights are present; otherwise free.

Input Parameters

string
required
Apollo conversation ID. A shared conversation can use the id_shareid format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_CONVERSATION_EXPORTRetrieve the download redirect URL for a previously started Apollo conversation export.

Input Parameters

string
required
The export ID returned by Export Conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_CURRENT_USER_PROFILEReturn the authenticated Apollo user’s identity and optional credit balances.

Input Parameters

boolean
Whether Apollo should include the user’s and team’s credit usage and remaining balances. Omit to use Apollo’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_DEALRetrieves information about a specific deal by its ID. Use this when you need to view details of a single deal.

Input Parameters

string
required
The ID for the deal you want to view. Each deal in the Apollo database is assigned a unique ID. To find deal IDs, call the List All Deals endpoint and identify the value for ‘id’ for the desired deal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_EMAIL_ACTIVITIESRetrieves content, open and click activity, and recipient details for one Apollo sequence email. Requires a master API key; OAuth is unsupported.

Input Parameters

string
required
The Apollo ID of the sequence email to inspect. Use Search Outreach Emails to find email IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_EMAIL_CONTENTRetrieve content for up to 10 sent team outreach emails.

Input Parameters

array
required
Apollo IDs of sent team outreach emails to retrieve. Apollo uses only the first 10 IDs and silently ignores any remainder. IDs without eligible sent emails are omitted from the response.
string ("plain" | "html")
Format for returned email bodies. Use plain for text without HTML tags or html for the original HTML.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_LABELSRetrieves all labels from Apollo.io, used for organizing contacts and accounts. Call this before APOLLO_CREATE_CONTACT or APOLLO_UPDATE_ACCOUNT to validate label values against the returned list; mismatched labels cause 400/422 errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_OPPORTUNITY_STAGESRetrieves all configured opportunity (deal) stages from the Apollo.io account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_ORGANIZATIONRetrieves organization information by Apollo ID, including available funding, technology, and employee data. Managed responses exclude account-specific fields.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per organization retrieved

Input Parameters

string
required
The Apollo ID for the organization that you want to research. To find organization IDs, call the Organization Search endpoint and identify the organization_id value for the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_ORGANIZATION_JOB_POSTINGSRetrieves paginated job postings for a specified organization by its ID, optionally filtering by domain; ensure organization_id is a valid identifier.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per job-posting result page

Input Parameters

integer
Page number for pagination.
integer
Number of job postings per page (max 100) for pagination.
string
required
The unique identifier for the organization whose job postings are being requested.
string
Filter job postings by the organization’s domain (e.g., ‘apollo.io’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_TASKRetrieves the full details of one Apollo task by ID, including associated records and type-specific data when present.

Input Parameters

string
required
The Apollo ID for the task to retrieve. Use Search for Tasks to find task IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_TYPED_CUSTOM_FIELDSRetrieves all typed custom field definitions available in the Apollo.io instance, detailing their types and configurations. Call before constructing payloads for APOLLO_UPDATE_CONTACT or APOLLO_UPDATE_ACCOUNT — mismatched types or invalid enum options cause 400 errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_GET_USERRetrieve one teammate in the connected Apollo workspace by Apollo user ID.

Input Parameters

string
required
Apollo user ID to retrieve. Use List Apollo Users to find user IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_ACCOUNT_STAGESRetrieves the IDs for all available account stages in your team’s Apollo account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_CONTACT_STAGESRetrieves all available contact stages from an Apollo account, including their unique IDs and names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_DEALSRetrieves a list of deals from Apollo, using Apollo’s default sort order if ‘sort_by_field’ is omitted.

Input Parameters

integer
Page number for paginated results.
integer
Number of deals to retrieve per page.
string
Field to sort deals by. If not provided, a default sort order is applied by the Apollo API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_EMAIL_ACCOUNTSRetrieves all email accounts and their details for the authenticated user; takes no parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_FIELDSRetrieves all field definitions from Apollo.io, including system fields and custom fields. Use the optional ‘source’ parameter to filter by field type (system, custom, or crm_synced).

Input Parameters

string ("system" | "custom" | "crm_synced")
Source type of the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_NOTESList notes associated with Apollo records. Supply at least one contact, account, opportunity, calendar-event, or conversation ID field.

Input Parameters

integer
Number of matching notes to skip. Apollo defaults to 0.
integer
Maximum number of notes to return, from 1 to 100. Apollo defaults to 25.
string
ID of an account whose notes to retrieve.
string
ID of a contact whose notes to retrieve.
string
Return notes created on or after this date, in YYYY-MM-DD format.
array
IDs of contacts whose notes to retrieve.
string ("created_at" | "updated_at")
Field by which to sort notes. Apollo defaults to created_at.
string
ID of an opportunity whose notes to retrieve.
string ("asc" | "desc")
Direction in which to sort notes. Apollo defaults to desc.
string
ID of a conversation whose notes to retrieve.
array
IDs of conversations whose notes to retrieve.
string
ID of a calendar event whose notes to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_LIST_USERSRetrieves a list of all users (teammates) associated with the Apollo account, supporting pagination via page and per_page parameters. Use this to obtain numeric user IDs required by operations like APOLLO_UPDATE_CONTACT_OWNERSHIP — names or email addresses are not accepted in place of these IDs.

Input Parameters

integer
Page number for pagination (e.g., 1, 2, 3…). Defaults to the first page if omitted.
integer
Number of users to retrieve per page (e.g., 10, 25, 50…). Defaults to a predefined page size if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_ORGANIZATION_ENRICHMENTFetches comprehensive organization enrichment data from Apollo.io for a given company domain; results are most meaningful if the company exists in Apollo’s database. Charged on every call; may be unavailable on free plans. Returns HTTP 429 under burst usage; use exponential backoff on retries.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per organization enriched

Input Parameters

string
required
The domain of the company to enrich, (e.g., ‘apollo.io’, ‘microsoft.com’). Do not include ‘www.’ or ’@’ symbols.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_ORGANIZATION_SEARCHSearch Apollo’s organization database using filters and paginated results. Calls are charged and may be unavailable on free plans; restrictive filters can yield no matches.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per organization search page

Input Parameters

integer
Page number for paginated results, used with per_page. Use total_pages from the response to iterate; a single call returns at most 100 records.
integer
Number of organization records per page, used with page.
array
Apollo’s unique organization IDs to fetch specific companies.
string
Organization name; supports partial matching (e.g., ‘Apollo’ matches ‘Apollo Inc.’).
array
Company HQs (city, state, country) to include; filters on primary HQ only.
array
Company HQs (city, state, country) to exclude; useful for territory management.
array
Company domains to filter by (e.g., ‘apollo.io’, ‘google.com’); exclude ‘www.’ or ’@’ prefixes. Normalize domain casing to improve match quality.
array
Keywords for company industries/specializations (e.g., ‘software’, ‘healthcare’).
array
Employee count ranges. Each string must be in ‘min,max’ format (e.g., ‘1,10’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_PEOPLE_ENRICHMENTEnriches a person using an Apollo ID, email, hashed email, LinkedIn URL, or first and last name with organization name or domain. Phone reveal requires a webhook; managed calls support base enrichment only, without personal email or phone reveal or webhook delivery.Instant: Supported on the latest version.Instant pricing: $0.02–$0.18 per person enriched; waterfall may cost more.

Input Parameters

string
The Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. To find IDs, call the People API Search endpoint and identify the values for person_id.
string
Full name of the person; used for matching instead of or with first_name and last_name.
string
The email address of the person.
string
Domain name of the person’s organization (e.g., ‘apollo.io’). Must be a bare hostname without protocol (http/https) or markup. Exclude ‘www.’ prefix.
string
The last name of the person.
string
The first name of the person.
string
Publicly accessible URL for Apollo to POST phone number data if reveal_phone_number is true. Phone data is delivered asynchronously via POST to this URL and is NOT returned inline in the API response.
string
MD5 or SHA-256 hashed email; used for matching if plain email is unavailable.
string
Full URL of the person’s LinkedIn profile.
string
Name of the person’s organization; used with name fields for matching.
boolean
If true, attempts to enrich with phone numbers; increases the price and requires webhook_url.
boolean
If true, attempts to enrich with personal emails; increases the price.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_PEOPLE_SEARCHSearches Apollo’s database for net-new prospects using filters, returning preview records with a display limit of 50,000. The search does not return email addresses or phone numbers; restrictive filter combinations can return no results.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

integer
Page number (1-based) for pagination. Max 500 if per_page is 100. Iterate until pagination.total_pages is reached to avoid missing contacts.
integer
Records per page. Max 100.
string
Search keywords for profile fields (names, skills, job descriptions, technologies). Use organizational filters (q_organization_domains, person_titles) as primary search criteria, then optionally add a first name here for refinement. Avoid full names (last names are often obfuscated in results). Do not combine names with skill keywords as this creates an AND search that may return no results.
array
Job titles (e.g., ‘software engineer’); matches if any title found, may include similar. Can be a list of titles or a comma-separated string. Each list entry must be a plain string — do not embed boolean operators (e.g., ‘title1 OR title2’) in a single string, as this returns zero results.
array
Apollo-specific company IDs to find people within these organizations; obtain from Organization Search. Can be a list or comma-separated string.
array
Current geographic locations of people (e.g., ‘London’, ‘California’, ‘Germany’). Can be a list or comma-separated string.
array
Job seniority levels for current positions (e.g., ‘Director’, ‘VP’, ‘Senior’). Can be a list or comma-separated string.
array
Email statuses to filter contacts. Allowed: ‘verified’, ‘unverified’, ‘likely to engage’, ‘unavailable’. Can be a list or comma-separated string.
array
Company HQs (e.g., ‘Texas’, ‘Tokyo’, ‘Spain’); uses primary HQ location. Can be a list or comma-separated string.
array
Company domains (e.g., ‘apollo.io’, ‘microsoft.com’); exclude ‘www.’ or ’@’ prefixes. Can be a list or comma-separated string.
array
Org employee count ranges for organizations (e.g., ‘1,10’, ‘10000,20000’); format as ‘min,max’ string. Can be a list or semicolon-separated string (e.g., ‘1,10;250,500’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_QUERY_ANALYTICS_REPORTQuery Apollo analytics metrics, dimensions, filters, and date ranges. This operation is free. Apollo rate limits depend on the connected team’s plan; use the returned rate_limit metadata as the source of truth. Metric and dimension descriptions include common Apollo identifiers; team-defined custom metrics use custom_metric_{id}.

Input Parameters

array
required
Zero or one metric sort. Apollo applies only the first sort.
object
required
Known filters plus additional dimension filters accepted by Apollo.
array
required
Metrics to query. An empty list returns no metric columns.
array
required
Zero or one row dimension; use an empty list for flat totals.
array
required
Zero or one preset date window for the query.
array
Optional zero or one column dimension for a pivot cross-tab.
array
Raw group keys to exclude, up to 500 values.
integer
Exclude ratio calculations whose denominator is below this threshold.
boolean
required
Include an aggregated totals row for the group dimension.
boolean
required
Include an aggregated totals column for the pivot dimension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_ACCOUNTSSearches for accounts within your existing Apollo.io database using various criteria; requires a paid plan and is limited to 50,000 records.

Input Parameters

integer
The page number for pagination, starting from 1. This is used with the ‘per_page’ parameter to navigate through results.
integer
The number of results to return per page. This is used for pagination in conjunction with the ‘page’ parameter. Maximum value is 100.
string
The field by which to sort the accounts. Valid options are: ‘account_last_activity_date’, ‘account_created_at’, ‘account_updated_at’.
boolean
Determines the sort order. Set to true for ascending order. This parameter must be used in conjunction with ‘sort_by_field’.
array
A list of Apollo IDs for account stages to filter the results by. These IDs can be retrieved using the ‘List Account Stages’ endpoint.
string
Keywords to search for in account names. This field supports partial name matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_CALLSSearches for call records in Apollo.io using filters like date range, duration, direction (inbound/outgoing), users, contacts, purposes, outcomes, and keywords. Supports pagination for efficient data retrieval.

Input Parameters

integer
Page number for pagination. Use with per_page to make search results navigable and improve performance.
string
Filter calls by direction: ‘incoming’ (prospect called your team) or ‘outgoing’ (your team called the prospect).
integer
Number of search results per page. Limiting results per page improves performance. Use page parameter to navigate pages.
array
Find calls that included specific users in your team’s Apollo account. Use the Get a List of Users endpoint to retrieve user IDs.
string
Keywords to narrow the search of calls in your team’s Apollo account.
integer
Upper bound for call duration in seconds. Use with duration_min. This number should be larger than duration_min.
integer
Lower bound for call duration in seconds. Use with duration_max. This number should be smaller than duration_max.
string
Upper bound of date range to search (format: YYYY-MM-DD). Use with date_range_min. This date should fall after date_range_min.
string
Lower bound of date range to search (format: YYYY-MM-DD). Use with date_range_max. This date should fall before date_range_max.
array
Find calls that included specific contacts. Contacts are people explicitly added to your database.
array
Filter calls based on their outcome. Call outcomes are unique to your team’s Apollo account. Find the outcome ID in the URL when using the Disposition filter in Apollo product.
array
Filter calls based on their purpose. Call purposes are unique to your team’s Apollo account. Find the purpose ID in the URL when using the Purpose filter in Apollo product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_CONTACTSSearches Apollo contacts using keywords, stage IDs (from ‘List Contact Stages’ action), or sorting (max 50,000 records; sort_ascending requires sort_by_field). Search before creating contacts to avoid duplicates.

Input Parameters

integer
Page number of results (1-indexed, max 500); use with ‘per_page’ for pagination. Check pagination.total_pages in the response to determine when to stop iterating.
integer
Contact records to return per page (max 100); for pagination.
string
Keywords for matching contact names, titles, employers, or emails.
string
Field to sort results. Valid options: ‘contact_last_activity_date’, ‘contact_email_last_opened_at’, ‘contact_email_last_clicked_at’, ‘contact_created_at’, ‘contact_updated_at’.
boolean
Sorts results in ascending order; requires ‘sort_by_field’.
array
Apollo contact stage IDs to filter contacts; obtain IDs using the ‘List Contact Stages’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_CONVERSATIONSSearch Apollo video meetings and dialer calls using record, participant, date, scorecard, sorting, and visibility filters.

Input Parameters

integer
Page number for pagination, starting at 1.
integer
Maximum number of conversation results to request.
array
Apollo label or tag IDs applied to the conversations.
string
Apollo account ID associated with the conversations.
object
Time window used to filter conversations.
array
Apollo contact IDs associated with the conversations.
array
Apollo tracker IDs associated with the conversations.
string
Conversation field by which Apollo should sort results.
array
Apollo organization IDs associated with the conversations.
string ("video_conference" | "phone_call")
Restrict results to video conferences or Apollo dialer calls.
number
Maximum scorecard rating included in the results.
string
Apollo scorecard template ID used to filter conversations.
boolean
Whether to restrict results to conversations visible to the specified contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_NEWS_ARTICLESTool to search for news articles about companies in Apollo’s database. Use when you need to find recent news, announcements, or updates about specific organizations using their Apollo IDs.Instant: Supported on the latest version.Instant pricing: Estimated $0.02 per news-result page

Input Parameters

integer
The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the per_page parameter to make search results for navigable and improve the performance of the endpoint. Example: 4
integer
The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint’s performance. Use the page parameter to search the different pages of data. Example: 10
array
Filter your search to include only certain categories or sub-categories of news. Use the News search filter for companies within Apollo to uncover all possible categories and sub-categories. Examples: hires, investment, contract
array
required
The Apollo IDs for the companies you want to include in your search results. Each company in the Apollo database is assigned a unique ID. To find IDs, call the Organization Search endpoint and identify the values for organization_id. Example: 5e66b6381e05b4008c8331b8
string
Set the upper bound of the date range you want to search. Use this parameter in combination with the published_at_min parameter. This date should fall after the published_at_min date. The date should be formatted as YYYY-MM-DD. Example: 2025-05-15
string
Set the lower bound of the date range you want to search. Use this parameter in combination with the published_at_max parameter. This date should fall before the published_at_max date. The date should be formatted as YYYY-MM-DD. Example: 2025-02-15

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_OUTREACH_EMAILSTool to search for outreach emails sent through Apollo sequences. Use when you need to find emails created and sent by your team as part of Apollo email campaigns. This endpoint requires a master API key and has a display limit of 50,000 records (100 records per page, up to 500 pages).

Input Parameters

integer
Page number for pagination (1-based). Maximum page number is 500.
integer
Number of email records per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_SEQUENCESSearch Apollo sequences, such as automated email campaigns, optionally filtering by full or partial name. Results are paginated, with a configurable page and page size.

Input Parameters

integer
Page number for paginated results.
string
Name or part of the name of the sequence to search for. If omitted, results are not filtered by name.
integer
Number of sequences per page. Maximum value is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEARCH_TASKSSearches for tasks in Apollo.io using filters like keywords, date ranges (due, created, updated), priorities, types, assigned users, associated contacts/accounts, supporting sorting and pagination.

Input Parameters

integer
Page number for pagination (starts from 1).
integer
Number of tasks per page (1-100).
string
Keywords for searching task notes or subjects (matches partial words).
array
List of task types to filter by (e.g., ‘call’, ‘email’).
array
List of account IDs to filter tasks by association.
array
List of contact IDs to filter tasks by association.
string
Field for sorting tasks. Note: This parameter may not be supported by the API and could result in ‘Invalid sort criteria’ error.
array
List of user IDs to filter tasks by assignment.
object
Filter tasks by due date range.
boolean
Sort order: true for ascending, false for descending.
array
List of lowercase task priorities to filter by. Valid values are ‘high’, ‘medium’, ‘low’.
object
Filter tasks by creation date range.
object
Filter tasks by last update date range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_SEND_EMAIL_NOWQueue an Apollo email for external sending; success means queued, not delivered. This action causes Apollo to send an email outside Composio. Apollo processes the send asynchronously, so callers must check send status separately for delivery. Reference: https://docs.apollo.io/reference/send-email-now

Input Parameters

string
required
Apollo ID of the drafted, scheduled, or failed email message to queue for immediate sending.
string
Apollo surface that initiated the send, used by Apollo for attribution and analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_ACCOUNTUpdates specified attributes of an existing account in Apollo.io.

Input Parameters

string
The new name for the account. This should be a human-readable name representing the organization.
string
The new primary phone number for the account. Apollo will attempt to sanitize and standardize the provided phone number format.
string
The new primary domain for the account. Ensure the ‘www.’ prefix is excluded (e.g., ‘apollo.io’ instead of ‘www.apollo.io’).
string
The unique identifier (ID) of the Apollo user to be assigned as the new owner of this account. This ID can be retrieved using the ‘Get a List of Users’ endpoint.
string
required
The unique Apollo identifier (ID) for the account to be updated. This ID can be retrieved using the ‘Search for Accounts’ endpoint.
string
The new corporate street address for the account. This can be a free-form string including details like street, city, state, and country.
string
The unique Apollo identifier (ID) for the new account stage (e.g., ‘Prospecting’, ‘Negotiation’). This ID can be retrieved using the ‘List Account Stages’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_ACCOUNT_OWNERSUpdates the ownership of multiple Apollo accounts to a specified user. Use when bulk assigning account ownership to a team member.

Input Parameters

string
required
The Apollo user ID to assign as the new owner for all specified accounts. This user must be part of your team’s Apollo account. Use the Get a List of Users endpoint to retrieve user IDs.
array
required
List of Apollo account IDs to update. Each ID uniquely identifies an account in your team’s Apollo instance. To find account IDs, use the Search for Accounts endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CALL_RECORDTool to update an existing call record in Apollo.io. Use when you need to modify details of a previously logged phone call such as duration, status, notes, or associated contact/account information.

Input Parameters

string
required
The Apollo ID for the call record to be updated. To find call record IDs, use the ‘Search for Calls’ action and identify the ‘id’ value for the call record.
string
Add a note to the call record.
boolean
Set to true if you want to create an individual record for the phone call in Apollo.
string ("queued" | "ringing" | "in-progress" | "completed" | "no_answer" | "failed" | "busy")
Enumeration of possible call status values.
array
Designate the caller(s) in your team’s Apollo account. Use the ‘Get a List of Users’ action to retrieve IDs for all users within your Apollo account.
integer
The duration of the call in seconds (not minutes).
string
The time when the call ended. Should adhere to ISO 8601 date-time format. Apollo uses GMT by default. You can adjust for timezone by specifying offset in hours and minutes.
string
The phone number that you dialed.
string
Associate the call with an account. Use the ‘Search for Accounts’ action to retrieve IDs for accounts within your Apollo account.
string
Designate the contact that was called. Use the ‘Search for Contacts’ action to retrieve IDs for contacts within your Apollo account.
string
The time when the call started. Should adhere to ISO 8601 date-time format. Apollo uses GMT by default. You can adjust for timezone by specifying offset in hours and minutes.
string
The phone number that dialed you.
string
Assign a call outcome to the record. Call outcomes are unique to your team’s Apollo account. When you use the Disposition search filter for calls in Apollo, you can find the corresponding call outcome ID in the URL.
string
Assign a call purpose to the record. Call purposes are unique to your team’s Apollo account. When you use the Purpose search filter for calls in Apollo, you can find the corresponding call purpose ID in the URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CONTACTTool to update an existing contact’s information in Apollo. Use when you need to modify contact details such as name, email, phone, title, organization, or custom fields. At least one field beyond contact_id must be provided.

Input Parameters

string
Update the contact email address.
string
Update the job title.
string
Update the contact’s last name.
string
Update the account ID. This associates the contact with a different account.
string
required
The Apollo ID for the contact that you want to update. To find contact IDs, call the ‘Search for Contacts’ action and identify the id value for the contact.
string
Update the contact’s first name.
string
Home phone number for the contact.
array
Replace lists this contact belongs to. Passing new values will overwrite existing lists.
string
Alternate phone number for the contact.
string
Update the employer website URL.
string
Primary direct phone number for the contact.
string
Mobile phone number for the contact.
string
Work/office phone number for the contact.
string
Update the contact stage ID. Use the ‘List Contact Stages’ action to get valid stage IDs.
string
Update the employer (company) name.
string
Update location (city/state/country) as a single string.
object
Add information to custom fields in Apollo. Your custom fields are unique to your team’s Apollo account. To utilize this parameter successfully, call the ‘Get a List of All Custom Fields’ action and identify the id value for the custom field, as well as the appropriate data type. For string fields, pass a string value. For picklist fields (single-select), pass a string with the picklist option ID. For multi-select picklist fields, pass a list of picklist option IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CONTACT_OWNERSHIPUpdates the ownership of specified Apollo contacts to a given Apollo user, who must be part of the same team.

Input Parameters

string
required
Unique Apollo identifier for the user, part of your team’s Apollo account, to become the new owner. Must be retrieved from APOLLO_LIST_USERS; names and emails are not accepted. An invalid or mismatched ID may cause a silent no-op with no explicit error returned.
array
required
Unique Apollo identifiers for existing contacts to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CONTACTS_BULKTool to bulk update multiple Apollo contacts with a single API call. Use when updating multiple contacts simultaneously - either apply the same updates to all contacts using contact_ids, or apply different updates to each contact using contact_attributes. Automatically processes asynchronously for more than 100 contacts.

Input Parameters

boolean
Force asynchronous processing. Automatically enabled for more than 100 contacts. When true, returns a job object instead of contact data.
string
When using contact_ids, apply this email to all contacts in the list.
string
When using contact_ids, apply this title to all contacts in the list.
string
When using contact_ids, apply this owner ID to all contacts in the list.
string
When using contact_ids, apply this last name to all contacts in the list.
string
When using contact_ids, apply this account ID to all contacts in the list.
string
When using contact_ids, apply this first name to all contacts in the list.
array
Array of contact IDs to update with the same values. Use this approach when applying identical updates to multiple contacts. Must provide either contact_ids or contact_attributes.
string
When using contact_ids, apply this LinkedIn URL to all contacts in the list.
string
When using contact_ids, apply this organization name to all contacts in the list.
array
Array of contact objects with individual updates. Use this approach when applying different updates to each contact. Must provide either contact_ids or contact_attributes.
array
Specific contact IDs to return in the response for performance optimization. Only these contacts will be included in the response.
string
When using contact_ids, apply this address to all contacts in the list.
object
When using contact_ids, apply these custom fields to all contacts in the list as key-value pairs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CONTACT_STAGEUpdates the stage for one or more existing contacts in Apollo.io to a new valid contact stage, useful for managing sales funnel progression.

Input Parameters

array
required
Unique identifiers for the contacts whose stage needs to be updated.
string
required
Unique identifier of the contact stage to assign to the contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_CONTACT_STATUS_IN_SEQUENCEPauses or marks a contact as finished in a designated Apollo sequence. Active status is not supported; the finished, bounced, and unsubscribed selections all request the same mark-as-finished operation.

Input Parameters

string ("active" | "paused" | "finished_replied" | "finished_not_replied" | "bounced" | "unsubscribed")
required
New status for the contact in the sequence. Note: ‘active’ status is not supported by this action.
string
required
Unique identifier of the contact.
string
required
Unique identifier of the sequence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_DEALSUpdates specified fields of an existing Apollo.io deal (opportunity), requiring a valid opportunity_id.

Input Parameters

string
The new human-readable name for the deal. Preserves current name if omitted.
string
The new monetary value of the deal (e.g., ‘50000’). Preserves current amount if omitted.
boolean
Indicates if the deal is won. true for won, false for lost/open. Preserves current status if omitted.
string
The new source from which this deal originated (e.g., ‘Website’, ‘Referral’). Preserves current source if omitted.
string
The unique identifier of the Apollo user to be assigned as the new owner. Obtain this ID via ‘List All Users’. Preserves current owner if omitted.
boolean
Indicates if the deal is closed. true for closed, false for open. Preserves current status if omitted.
string
The unique Apollo identifier of the account to be associated. Obtain this ID from account-related actions. Preserves current account if omitted.
string
The new estimated or actual close date (YYYY-MM-DD). Preserves current close date if omitted.
string
required
The unique identifier of the Apollo opportunity (deal) to be updated.
string
The unique identifier for the new stage. Obtain this ID via ‘List Deal Stages’. Preserves current stage if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_LABELRename an Apollo list and optionally change its Book of Business status. Reference: https://docs.apollo.io/reference/update-a-list

Input Parameters

string
required
New list name, unique within its modality.
string
required
Apollo ID of the list to update. Use Get Labels to find it.
boolean
Whether an account list is a Book of Business list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_SEQUENCEUpdate an Apollo sequence’s settings, ownership, sharing, steps, and touches. Supplying emailer_steps replaces the ordered step set and can create, update, reorder, or remove steps and their touches based on the IDs supplied. Apollo can require the current complete step list even for a settings-only update. Reference: https://docs.apollo.io/reference/update-sequence

Input Parameters

string
required
Apollo ID of the sequence to update.
string
New sequence name.
string
Apollo user ID of the sequence’s new owner.
string
Comma-separated email addresses to CC on sequence emails.
string
Comma-separated email addresses to BCC on sequence emails.
array
Replacement list of labels or folders for the sequence.
string ("draft" | "new" | "ai_assistant")
Sequence creation type.
array
Complete ordered step list. Entries with IDs update or reorder existing steps, entries without IDs create steps, and existing steps omitted from this list are removed. Apollo can reject other updates with ‘At least one step is required’ unless the current complete step list is included.
integer
Maximum number of emails this sequence can send per day.
object
Visibility and user or team sharing changes. Sharing access changes may require plan support.
string
Apollo ID of a non-empty team sending schedule to attach.
integer
Days to wait before contacting another person at the same account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_UPDATE_TASKUpdate editable details of an existing Apollo task. Supply at least one update field in addition to task_id.

Input Parameters

string
Human-readable task description. This can also be changed on completed or skipped tasks.
string ("call" | "outreach_manual_email" | "linkedin_step_connect" | "linkedin_step_message" | "linkedin_step_view_profile" | "linkedin_step_interact_post" | "action_item")
Task type. Only applies to scheduled tasks.
string
Task title. Only applies to scheduled tasks.
string
Due date and time in ISO 8601 format. Only applies to scheduled tasks.
string
Task status. Only applies to scheduled tasks; use Complete Task or Skip Task instead of setting a task done here.
string
required
The Apollo ID of the task to update. Use Search Tasks to find task IDs.
string
ID of the task owner. Only applies to tasks with scheduled status.
string ("high" | "medium" | "low")
Task priority. For a scheduled task, include its current priority even when changing another field because Apollo resets an omitted priority to medium.
string
Apollo ID of the contact associated with the task.
string
ID of the task creator. For a scheduled task, include its current creator_id even when changing another field because Apollo resets an omitted creator_id to the API key’s user.
string
Call script or talking points for a scheduled call task.
array
Names of team-defined relevant fields to surface for a scheduled task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_VIEW_API_USAGE_STATSFetches Apollo API usage statistics and rate limits for the connected team. Use before large enrichment/search runs to understand current API usage and plan/budget constraints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APOLLO_VIEW_CREDIT_USAGE_STATSRead team balances by credit type for Apollo’s current billing cycle. Balance values represent credits except for the dialer key, which Apollo reports in minutes. This operation is free.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not