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

# Apollo: Add Contacts To Sequence

> Add Apollo contacts to a sequence, choosing the sending mailbox and whether to include contacts already in other sequences.

Add Apollo contacts to a sequence, choosing the sending mailbox and whether to include contacts already in other sequences.

> [!NOTE]
>
> Tool ID: `apollo_add_contacts_to_sequence`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_add_contacts_to_sequence',
  {
    "emailer_campaign_id": "jane.doe@example.com",
    "send_email_from_email_account_id": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute apollo_add_contacts_to_sequence --input '{
  "emailer_campaign_id": "jane.doe@example.com",
  "send_email_from_email_account_id": "jane.doe@example.com"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe apollo_add_contacts_to_sequence --json` for the complete live contract.

## Input reference

Add contacts to an Apollo email sequence. Requires master API key. Contacts must already exist in Apollo. At least one of contact\_ids or label\_names is required.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.emailer_campaign_id` | `string` | Yes | — | The Apollo sequence ID to add contacts to. |
| `payload.contact_ids` | `array` | No | — | Array of Apollo contact IDs to add. At least one of contact\_ids or label\_names is required. |
| `payload.send_email_from_email_account_id` | `string` | Yes | — | Email account ID to send from. Get IDs from apollo\_list\_email\_accounts. |
| `payload.user_id` | `string` | No | — | Apollo user ID who owns the sending. |
| `payload.sequence_no_email` | `boolean` | No | — | Add contacts even if they have no email. |
| `payload.sequence_active_in_other_campaigns` | `boolean` | No | — | Add even if the contact is active/paused in another sequence. |
| `payload.sequence_finished_in_other_campaigns` | `boolean` | No | — | Add even if the contact has finished another sequence. |
| `payload.label_names` | `array` | No | — | Label names to select contacts from. At least one of contact\_ids or label\_names is required. |
| `payload.send_email_from_email_address` | `string` | No | — | Email address to send from (alternative to email account ID). |
| `payload.sequence_unverified_email` | `boolean` | No | — | Add contacts with unverified emails. |
| `payload.sequence_job_change` | `boolean` | No | — | Add contacts even if a job change was detected. |
| `payload.sequence_same_company_in_same_campaign` | `boolean` | No | — | Add contacts from the same company already in the campaign. |
| `payload.contacts_without_ownership_permission` | `boolean` | No | — | Add contacts without ownership permission. |
| `payload.add_if_in_queue` | `boolean` | No | — | Add contacts even if they are in a sending queue. |
| `payload.contact_verification_skipped` | `boolean` | No | — | Skip contact verification when adding. |
| `payload.status` | `string` | No | — | Initial status for added contacts in the sequence. |
| `payload.auto_unpause_at` | `string` | No | — | ISO 8601 date/time to auto-unpause the contact in the sequence. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Add contacts to an Apollo email sequence. Requires master API key. Contacts must already exist in Apollo. At least one of contact_ids or label_names is required.",
    "properties": {
      "emailer_campaign_id": {
        "type": "string",
        "description": "The Apollo sequence ID to add contacts to."
      },
      "contact_ids": {
        "type": "array",
        "description": "Array of Apollo contact IDs to add. At least one of contact_ids or label_names is required.",
        "items": {
          "type": "string"
        }
      },
      "send_email_from_email_account_id": {
        "type": "string",
        "description": "Email account ID to send from. Get IDs from apollo_list_email_accounts."
      },
      "user_id": {
        "type": "string",
        "description": "Apollo user ID who owns the sending."
      },
      "sequence_no_email": {
        "type": "boolean",
        "description": "Add contacts even if they have no email."
      },
      "sequence_active_in_other_campaigns": {
        "type": "boolean",
        "description": "Add even if the contact is active/paused in another sequence."
      },
      "sequence_finished_in_other_campaigns": {
        "type": "boolean",
        "description": "Add even if the contact has finished another sequence."
      },
      "label_names": {
        "type": "array",
        "description": "Label names to select contacts from. At least one of contact_ids or label_names is required.",
        "items": {
          "type": "string"
        }
      },
      "send_email_from_email_address": {
        "type": "string",
        "description": "Email address to send from (alternative to email account ID)."
      },
      "sequence_unverified_email": {
        "type": "boolean",
        "description": "Add contacts with unverified emails."
      },
      "sequence_job_change": {
        "type": "boolean",
        "description": "Add contacts even if a job change was detected."
      },
      "sequence_same_company_in_same_campaign": {
        "type": "boolean",
        "description": "Add contacts from the same company already in the campaign."
      },
      "contacts_without_ownership_permission": {
        "type": "boolean",
        "description": "Add contacts without ownership permission."
      },
      "add_if_in_queue": {
        "type": "boolean",
        "description": "Add contacts even if they are in a sending queue."
      },
      "contact_verification_skipped": {
        "type": "boolean",
        "description": "Skip contact verification when adding."
      },
      "status": {
        "type": "string",
        "description": "Initial status for added contacts in the sequence."
      },
      "auto_unpause_at": {
        "type": "string",
        "description": "ISO 8601 date/time to auto-unpause the contact in the sequence."
      }
    },
    "required": [
      "emailer_campaign_id",
      "send_email_from_email_account_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo add contacts to sequence result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `record` | Yes | — | Payload with `contacts`, `skipped_contact_ids`, `emailer_campaign`, and `emailer_steps`. |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Apollo add contacts to sequence result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with `contacts`, `skipped_contact_ids`, `emailer_campaign`, and `emailer_steps`.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Apollo provider guide](https://deepline.com/docs/providers/apollo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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