Apollo

Parámetros de entrada

• user_idstring

  Optional unique ID of the user performing the action (in request body if specified).

• contact_idsstring[]Obligatorio

  List of unique Apollo contact IDs to add to the sequence (in request body).

• sequence_idstringObligatorio

  Unique ID of the Apollo sequence to add contacts to (path parameter).

• sequence_no_emailboolean

  If true, add contacts without an email address (query parameter).

• emailer_campaign_idstringObligatorio

  Unique ID of the Apollo emailer campaign (should match `sequence_id`; in request body).

• sequence_job_changeboolean

  If true, add contacts who recently changed jobs (query parameter).

• sequence_unverified_emailboolean

  If true, add contacts with unverified emails (query parameter).

• send_email_from_email_account_idstringObligatorio

  Unique ID of the Apollo email account for sending emails (in request body).

• sequence_active_in_other_campaignsboolean

  If true, add contacts active in other sequences (query parameter).

• sequence_finished_in_other_campaignsboolean

  If true, add contacts finished in other sequences (query parameter).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• domainsstring[]Obligatorio

  A list of company domains to enrich. Domains should be base domains (e.g., 'apollo.io') and not include 'www.', '@', or protocols like 'http://'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• detailsobject[]Obligatorio

  List of up to 10 person objects to enrich. For effective matching, include key identifiers like email, LinkedIn URL, or name plus company information.

• webhook_urlstring

  Webhook URL for phone number delivery if `reveal_phone_number` is true; mandatory in that case.

• reveal_phone_numberboolean

  If true, enriches with all available phone numbers; may consume credits and requires 'webhook_url'.

• reveal_personal_emailsboolean

  If true, enriches with personal emails; may consume additional credits.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_idsstring[]Obligatorio

  A list of unique identifiers for accounts whose stage needs to be updated.

• account_stage_idstringObligatorio

  The unique identifier of the account stage to which the specified accounts will be moved.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Human-readable name for the account.

• phonestring

  Primary phone number for the account (e.g., main corporate line, branch, or direct dial).

• domainstring

  Company's primary domain name (e.g., 'apollo.io', not 'www.apollo.io') to help Apollo enrich account data.

• owner_idstring

  Unique ID of the user within your Apollo team to be assigned as owner; retrieve via the 'Get a List of Users' endpoint.

• raw_addressstring

  Physical address or general location of the account (e.g., full street address or 'City, State, Country').

• account_stage_idstring

  Unique ID for the account's sales stage (e.g., 'Prospecting' or 'Closed Won'); retrieve via the 'List Account Stages' endpoint.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with the full object of the newly created account as returned by Apollo.io, including ID, name, domain, and other processed or enriched information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstring

  The primary email address for the contact.

• titlestring

  The contact's current job title.

• last_namestringObligatorio

  Last name of the contact.

• account_idstring

  Apollo ID of the organization to assign this contact; obtain via 'Organization Search' (usually the `id` field).

• first_namestringObligatorio

  First name of the contact.

• home_phonestring

  Home phone number. Apollo attempts to parse/sanitize format.

• label_namesstring[]

  Descriptive labels to categorize the contact; new labels create new lists in Apollo.

• other_phonestring

  Alternative or unspecified-type phone number. Apollo attempts to parse/sanitize format.

• website_urlstring

  Full corporate website URL for the contact's employer (e.g., 'https://www.apollo.io/'); must be an official company site, not social media.

• direct_phonestring

  Primary direct dial phone number. Apollo attempts to parse/sanitize format.

• mobile_phonestring

  Mobile phone number. Apollo attempts to parse/sanitize format.

• corporate_phonestring

  Work or office direct line. Apollo attempts to parse/sanitize format.

• contact_stage_idstring

  Apollo ID for the contact's sales/engagement stage (e.g., representing 'Approaching'); obtain via an action listing contact stages.

• organization_namestring

  Name of the contact's current organization. Use 'Organization Search' for the exact Apollo-recognized name for best results.

• present_raw_addressstring

  Contact's current location as a single string (e.g., 'Atlanta, United States', 'Tokyo, Japan').

Parámetros de salida

• dataobjectObligatorio

  Dictionary with the newly created contact's data from Apollo API, matching Apollo's standard contact object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Human-readable name for the new deal.

• amountstring

  Monetary value (string of numbers only, e.g., '50000', no symbols/commas). Currency is based on Apollo account settings.

• owner_idstring

  Unique identifier of the Apollo user owning this deal. Retrieve via 'Get a List of Users' endpoint.

• account_idstring

  Unique identifier of the Apollo account (company) for this deal. Find via 'Organization Search' endpoint.

• closed_datestring

  Anticipated deal closing date (YYYY-MM-DD).

• opportunity_stage_idstring

  Unique identifier for the deal's sales pipeline stage (e.g., 'Prospecting'). Retrieve via 'List Deal Stages' endpoint.

Parámetros de salida

• dataobjectObligatorio

  Comprehensive details of the newly created deal from the Apollo API, including its ID and all specified attributes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• notestring

  An optional note or description providing additional context for the task(s). This is particularly recommended for tasks of type 'action_item'.

• typestringObligatorio

  The type of task to be created. Accepted values: 'call', 'outreach_manual_email', 'linkedin_step_connect', 'linkedin_step_message', 'linkedin_step_view_profile', 'linkedin_step_interact_post', 'action_item'.

• due_atstringObligatorio

  The due date and time for the task(s), specified in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS+HH:MM'). If no timezone offset is provided, GMT is assumed.

• statusstringObligatorio

  The status to assign to the newly created task(s). For new, upcoming tasks, 'scheduled' is appropriate. Other common values include 'completed' or 'archived' for tasks already finished.

• user_idstringObligatorio

  The ID of the user in your Apollo account who will own the created task(s). This ID can be retrieved using the 'Get a List of Users' endpoint.

• prioritystringObligatorio

  The priority level for the task(s). Accepted values: 'high', 'medium', 'low'.

• contact_idsstring[]Obligatorio

  A list of Apollo contact IDs for whom tasks will be created. A separate task is generated for each contact ID in this list.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the Apollo API's response to the task creation request.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for pagination.

• per_pageinteger

  Number of job postings per page (max 100) for pagination.

• organization_idstringObligatorio

  The unique identifier for the organization whose job postings are being requested.

• q_organization_domainsstring

  Filter job postings by the organization's domain (e.g., 'apollo.io').

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Contains account stages, usually under an 'account_stages' key, as a list of objects where each object has an 'id' and 'name'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The raw JSON response from the API as a dictionary, expected to contain a list of contact stages (often under a key like 'contact_stages'), each detailed with an ID and name.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for paginated results.

• per_pageinteger

  Number of deals to retrieve per page.

• sort_by_fieldstring

  Field to sort deals by. If not provided, a default sort order is applied by the Apollo API.

Parámetros de salida

• dataobjectObligatorio

  Raw JSON response from the Apollo API, typically including a list of deals and pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for pagination (e.g., 1, 2, 3...). Defaults to the first page if omitted.

• per_pageinteger

  Number of users to retrieve per page (e.g., 10, 25, 50...). Defaults to a predefined page size if omitted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the raw JSON response from the Apollo API. This typically includes a list of users, their associated details, and pagination metadata (e.g., total entries, current page) if applicable.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• domainstringObligatorio

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

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the enriched data for the organization from Apollo.io. This can include details such as industry, revenue, employee count, funding information, technologies used, and more.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for paginated results, used with `per_page`.

• per_pageinteger

  Number of organization records per page, used with `page`.

• organization_idsstring[]

  Apollo's unique organization IDs to fetch specific companies.

• q_organization_namestring

  Organization name; supports partial matching (e.g., 'Apollo' matches 'Apollo Inc.').

• organization_locationsstring[]

  Company HQs (city, state, country) to include; filters on primary HQ only.

• organization_not_locationsstring[]

  Company HQs (city, state, country) to exclude; useful for territory management.

• q_organization_keyword_tagsstring[]

  Keywords for company industries/specializations (e.g., 'software', 'healthcare').

• organization_num_employees_rangesstring[]

  Employee count ranges. Each string must be in 'min,max' format (e.g., '1,10').

Parámetros de salida

• dataobjectObligatorio

  API response: list of matching organizations and pagination details (total records, current page, records per page).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstring

  Unique Apollo ID for the person, ensuring a direct match.

• namestring

  Full name of the person; used for matching instead of or with `first_name` and `last_name`.

• emailstring

  The email address of the person.

• domainstring

  Domain name of the person's organization (e.g., 'apollo.io'); exclude 'www.' or 'http(s)://'. Used for matching.

• last_namestring

  The last name of the person.

• first_namestring

  The first name of the person.

• webhook_urlstring

  Publicly accessible URL for Apollo to POST phone number data if `reveal_phone_number` is true.

• hashed_emailstring

  MD5 or SHA-256 hashed email; used for matching if plain email is unavailable.

• linkedin_urlstring

  Full URL of the person's LinkedIn profile.

• organization_namestring

  Name of the person's organization; used with name fields for matching.

• reveal_phone_numberboolean

  If true, attempts to enrich with phone numbers; may incur additional API credits and requires `webhook_url`.

• reveal_personal_emailsboolean

  If true, attempts to enrich with personal emails; may incur additional API credits.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with enriched data for the person from Apollo.io; structure and content vary based on information found and requested.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number (1-based) for pagination. Max 500 if `per_page` is 100.

• per_pageinteger

  Records per page. Max 100.

• q_keywordsstring

  Keywords for person profile fields like skills, job descriptions, or technologies (e.g., 'marketing technology', 'saas sales').

• person_titlesstring[]

  Job titles (e.g., 'software engineer'); matches if any title found, may include similar.

• organization_idsstring[]

  Apollo-specific company IDs to find people within these organizations; obtain from Organization Search.

• person_locationsstring[]

  Current geographic locations of people (e.g., 'London', 'California', 'Germany').

• person_senioritiesstring[]

  Job seniority levels for current positions (e.g., 'Director', 'VP', 'Senior').

• contact_email_statusstring[]

  Email statuses to filter contacts. Allowed: 'verified', 'unverified', 'likely to engage', 'unavailable'.

• organization_locationsstring[]

  Company HQs (e.g., 'Texas', 'Tokyo', 'Spain'); uses primary HQ location.

• q_organization_domainsstring[]

  Company domains (e.g., 'apollo.io', 'microsoft.com'); exclude 'www.' or '@' prefixes.

• organization_num_employees_rangesstring[]

  Org employee count ranges for organizations (e.g., '1,10', '10000,20000'); format as 'min,max' string.

Parámetros de salida

• dataobjectObligatorio

  Search results, including a list of people (e.g., under 'people' key) and pagination details (total entries, current page, total pages).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  The page number for pagination, starting from 1. This is used with the 'per_page' parameter to navigate through results.

• per_pageinteger

  The number of results to return per page. This is used for pagination in conjunction with the 'page' parameter. Maximum value is 100.

• sort_by_fieldstring

  The field by which to sort the accounts. Valid options are: 'account_last_activity_date', 'account_created_at', 'account_updated_at'.

• sort_ascendingboolean

  Determines the sort order. Set to true for ascending order. This parameter must be used in conjunction with 'sort_by_field'.

• account_stage_idsstring[]

  A list of Apollo IDs for account stages to filter the results by. These IDs can be retrieved using the 'List Account Stages' endpoint.

• q_organization_namestring

  Keywords to search for in account names. This field supports partial name matching.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the search results, including a list of accounts and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results (1-indexed, max 500); use with 'per_page' for pagination.

• per_pageinteger

  Contact records to return per page (max 100); for pagination.

• q_keywordsstring

  Keywords for matching contact names, titles, employers, or emails.

• sort_by_fieldstring

  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'.

• sort_ascendingboolean

  Sorts results in ascending order; requires 'sort_by_field'.

• contact_stage_idsstring[]

  Apollo contact stage IDs to filter contacts; obtain IDs using the 'List Contact Stages' action.

Parámetros de salida

• dataobjectObligatorio

  Search results, including 'contacts' list and 'pagination' details (e.g., 'page', 'per_page', 'total_entries', 'total_pages').

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for paginated results.

• q_namestring

  Name or part of the name of the sequence to search for. If omitted, results are not filtered by name.

• per_pageinteger

  Number of sequences per page. Maximum value is 100.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number for pagination (starts from 1).

• per_pageinteger

  Number of tasks per page (1-100).

• q_keywordsstring

  Keywords for searching task notes or subjects (matches partial words).

• task_typesstring[]

  List of task types to filter by (e.g., 'call', 'email').

• account_idsstring[]

  List of account IDs to filter tasks by association.

• contact_idsstring[]

  List of contact IDs to filter tasks by association.

• sort_by_fieldstring

  Field for sorting tasks (e.g., 'due_date', 'created_at').

• task_user_idsstring[]

  List of user IDs to filter tasks by assignment.

• due_date_rangeobject

  Filter tasks by due date range.

• sort_ascendingboolean

  Sort order: `true` for ascending, `false` for descending.

• task_prioritiesstring[]

  List of case-sensitive task priorities to filter by (e.g., 'High', 'Normal').

• task_created_at_rangeobject

  Filter tasks by creation date range.

• task_updated_at_rangeobject

  Filter tasks by last update date range.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new name for the account. This should be a human-readable name representing the organization.

• phonestring

  The new primary phone number for the account. Apollo will attempt to sanitize and standardize the provided phone number format.

• domainstring

  The new primary domain for the account. Ensure the 'www.' prefix is excluded (e.g., 'apollo.io' instead of 'www.apollo.io').

• owner_idstring

  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.

• account_idstringObligatorio

  The unique Apollo identifier (ID) for the account to be updated. This ID can be retrieved using the 'Search for Accounts' endpoint.

• raw_addressstring

  The new corporate street address for the account. This can be a free-form string including details like street, city, state, and country.

• account_stage_idstring

  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.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full, updated details of the account as returned by Apollo after the modification.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstring

  The contact's new primary email address.

• titlestring

  The contact's new job title.

• last_namestring

  The contact's new last name.

• account_idstring

  The Apollo ID of the account to which the contact should be (re)assigned. If provided, this updates the contact's associated account.

• contact_idstringObligatorio

  The unique Apollo identifier for the contact to be updated. This ID can be obtained using the 'Search for Contacts' action.

• first_namestring

  The contact's new first name.

• home_phonestring

  The contact's new home phone number.

• label_namesstring[]

  The updated list of label names to associate with the contact. These labels help categorize contacts within your team's Apollo account.

• other_phonestring

  An alternative or uncategorized new phone number for the contact.

• website_urlstring

  The new corporate website URL for the contact's current employer.

• direct_phonestring

  The contact's new primary direct phone number.

• mobile_phonestring

  The contact's new mobile phone number.

• corporate_phonestring

  The contact's new work or office phone number.

• contact_stage_idstring

  The Apollo ID for the contact's new stage. This ID can be obtained using the 'List Contact Stages' action.

• organization_namestring

  The new name of the company or organization the contact is associated with.

• present_raw_addressstring

  The contact's new personal location or address, provided as a single string.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing all fields of the contact after the update, as returned by the Apollo API. This includes both updated and unchanged fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• owner_idstringObligatorio

  Unique Apollo identifier for the user, part of your team's Apollo account, to become the new owner.

• contact_idsstring[]Obligatorio

  Unique Apollo identifiers for existing contacts to update.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• contact_idsstring[]Obligatorio

  Unique identifiers for the contacts whose stage needs to be updated.

• contact_stage_idstringObligatorio

  Unique identifier of the contact stage to assign to the contacts.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• statusstringObligatorioenum

  New status for the contact in the sequence. Note: 'active' status is not supported by this action.

  activepausedfinished_repliedfinished_not_repliedbouncedunsubscribed
• contact_idstringObligatorio

  Unique identifier of the contact.

• sequence_idstringObligatorio

  Unique identifier of the sequence.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new human-readable name for the deal. Preserves current name if omitted.

• amountstring

  The new monetary value of the deal (e.g., '50000'). Preserves current amount if omitted.

• is_wonboolean

  Indicates if the deal is won. `true` for won, `false` for lost/open. Preserves current status if omitted.

• sourcestring

  The new source from which this deal originated (e.g., 'Website', 'Referral'). Preserves current source if omitted.

• owner_idstring

  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.

• is_closedboolean

  Indicates if the deal is closed. `true` for closed, `false` for open. Preserves current status if omitted.

• account_idstring

  The unique Apollo identifier of the account to be associated. Obtain this ID from account-related actions. Preserves current account if omitted.

• closed_datestring

  The new estimated or actual close date (YYYY-MM-DD). Preserves current close date if omitted.

• opportunity_idstringObligatorio

  The unique identifier of the Apollo opportunity (deal) to be updated.

• opportunity_stage_idstring

  The unique identifier for the new stage. Obtain this ID via 'List Deal Stages'. Preserves current stage if omitted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the complete, updated details of the deal from the Apollo API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not