> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Apollo

> Add a bot to Apollo using the official integration.

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01K6BJFKR5WZV44VNENAN6XBT1)
*v3.0.2*

The official Apollo integration allows your bot to create, enrich, update or search your Apollo contacts.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * An [Apollo account](https://www.apollo.io/sign-up)

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
2. Search for the **Apollo.io** integration, then select **Install Integration**.

In the **Configuration** menu, you should see one field: **API Key**. Leave it empty for now—you'll come back to it after creating your Apollo API key.

**2. Create an Apollo API key**

Next, create an Apollo API key:

1. [Log in to your Apollo account](https://app.apollo.io/#/login).

2. Select **Admin Settings** from the bottom-left corner.

3. Select **Integrations**.

4. Scroll all the way down and select **API**.

5. From the left navigation bar, select **API Keys**.

6. Fill out the required fields. From the **APIs** drop-down, select:

   * `api/v1/people/match`
   * `api/v1/people/bulk_match`
   * `api/v1/contacts/create`
   * `api/v1/contacts/update`
   * `api/v1/contacts/search`

7. Select **Create API key**, then copy the generated key.

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **API Key** field, paste your apollo API key.
2. Select **Save Configuration**.

> [!TIP]
>
> Your Apollo integration is ready. You can use the integration's [Cards](#cards) to interact with your Apollo subscribers.

***

## Cards

> [!NOTE]
>
> Any enrichment operations you perform consume credits from your [Apollo pricing plan](https://www.apollo.io/pricing).

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Bulk Enrich People

Enrich a list of people from your team's Apollo.io account

**input** `object`

**reveal\_personal\_emails** `boolean`

Set to true if you want to enrich the person's data with personal emails. This potentially consumes credits as part of your Apollo pricing plan. The default value is false.

**reveal\_phone\_numbers** `boolean`

Set to true if you want to enrich the person's data with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your Apollo pricing plan. The default value is false. If this parameter is set to true, you must enter a webhook URL for the webhook\_url parameter. Apollo will asynchronously verify phone numbers for you, then send a JSON response that includes only details about the person's phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.

**webhook\_url** `string (uri)`

If you set the reveal\_phone\_number parameter to true, this parameter becomes mandatory. Otherwise, do not use this parameter. Enter the webhook URL that specifies where Apollo should send a JSON response that includes the phone number you requested. Apollo suggests testing this flow to ensure you receive the separate response with the phone number. If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL.

**people** `array` *required*

Array of people to enrich

**array item properties**

**first\_name** `string`

First name

**last\_name** `string`

Last name

**name** `string`

Full name

**email** `string (email)`

Email address

**hashed\_email** `string`

Hashed email address

**organization\_name** `string`

Name of the person's employer

**domain** `string`

The domain name for the person's current or previous employer. Do NOT include [www](http://www)., @ or similar.

**id** `string`

Apollo ID for the person

**linkedin\_url** `string (uri)`

LinkedIn profile URL

**output** `object`

**apiResponse** `object` *required*

**message** `string` *required*

Status message about the API response

### Create Contact

Create a new contact in Apollo.io

**input** `object`

**first\_name** `string`

Contact first name

**last\_name** `string`

Contact last name

**email** `string (email)`

Contact email address

**organization\_name** `string`

Organization/company name

**title** `string`

Job title

**account\_id** `string`

Account ID in Apollo

**website\_url** `string (uri)`

Website URL

**label\_names** `array`

Array of label names to assign

**contact\_stage\_id** `string`

Contact stage ID

**present\_raw\_address** `string`

Contact address

**direct\_phone** `string`

Direct phone number

**corporate\_phone** `string`

Corporate phone number

**mobile\_phone** `string`

Mobile phone number

**home\_phone** `string`

Home phone number

**other\_phone** `string`

Other phone number

**typed\_custom\_fields** `object`

Custom fields as key-value pairs

**output** `object`

**apiResponse** `object` *required*

**message** `string` *required*

Status message about the API response

### Enrich Person

Enrich a person from your team's Apollo.io account

**input** `object`

**first\_name** `string`

First name

**last\_name** `string`

Last name

**name** `string`

Full name

**email** `string (email)`

Email address

**hashed\_email** `string`

Hashed email address

**organization\_name** `string`

Name of the person's employer

**domain** `string`

The domain name for the person's current or previous employer. Do NOT include [www](http://www)., @ or similar.

**id** `string`

Apollo ID for the person

**linkedin\_url** `string (uri)`

LinkedIn profile URL

**reveal\_personal\_emails** `boolean`

Set to true if you want to enrich the person's data with personal emails. This potentially consumes credits as part of your Apollo pricing plan. The default value is false.

**reveal\_phone\_numbers** `boolean`

Set to true if you want to enrich the person's data with all available phone numbers, including mobile phone numbers. This potentially consumes credits as part of your Apollo pricing plan. The default value is false. If this parameter is set to true, you must enter a webhook URL for the webhook\_url parameter. Apollo will asynchronously verify phone numbers for you, then send a JSON response that includes only details about the person's phone numbers to the webhook URL you provide. It can take several minutes for the phone numbers to be delivered.

**webhook\_url** `string (uri)`

If you set the reveal\_phone\_number parameter to true, this parameter becomes mandatory. Otherwise, do not use this parameter. Enter the webhook URL that specifies where Apollo should send a JSON response that includes the phone number you requested. Apollo suggests testing this flow to ensure you receive the separate response with the phone number. If phone numbers are not revealed delivered to the webhook URL, try applying UTF-8 encoding to the webhook URL.

**output** `object`

**apiResponse** `object` *required*

**message** `string` *required*

Status message about the API response

### Search Contacts

Find contacts from your team's Apollo.io account

**input** `object`

**q\_keywords** `string`

Keywords to narrow search. Can include combinations of names, job titles, employers (company names), and email addresses (Eg. "John Doe", "John Botpress", "John Director Botpress", "[john@botpress.com](mailto:john@botpress.com)", "John [john@xyz.com](mailto:john@xyz.com)", etc.).

**contact\_stage\_ids** `array`

Apollo IDs for the contact stages that you want to include in your search results. Adding multiple IDs will return matching contacts from all of the specified stages.

**sort\_by\_field** `string`

Field to sort the search results by. Valid options are "contact\_last\_activity\_date", "contact\_email\_last\_opened\_at", "contact\_email\_last\_clicked\_at", "contact\_created\_at" and "contact\_updated\_at".

**sort\_ascending** `boolean`

Set true to sort the results in ascending order. Default is false. Must be used in conjunction with sortByField.

**page** `number`

Page number of results to return.

**per\_page** `number`

Number of contacts to return per page. Limiting the number of contacts returned will speed up the search process.

**output** `object`

**apiResponse** `object` *required*

**message** `string` *required*

Status message about the API response

### Update Contact

Update a contact in Apollo.io

**input** `object`

**contact\_id** `string` *required*

The ID of the contact to update in Apollo

**first\_name** `string`

Contact first name

**last\_name** `string`

Contact last name

**email** `string (email)`

Contact email address

**organization\_name** `string`

Organization/company name

**title** `string`

Job title

**account\_id** `string`

Account ID in Apollo

**website\_url** `string (uri)`

Website URL

**label\_names** `array`

Array of label names to assign

**contact\_stage\_id** `string`

Contact stage ID

**present\_raw\_address** `string`

Contact address

**direct\_phone** `string`

Direct phone number

**corporate\_phone** `string`

Corporate phone number

**mobile\_phone** `string`

Mobile phone number

**home\_phone** `string`

Home phone number

**other\_phone** `string`

Other phone number

**typed\_custom\_fields** `object`

Custom fields as key-value pairs

**output** `object`

**apiResponse** `object` *required*

**message** `string` *required*

Status message about the API response


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.