> ## 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: Remove Contacts From Sequence

> ## Endpoint essentials **API key access:** `api/v1/emailer_campaigns/remove_or_stop_contact_ids` or `Master API key` **OAuth scopes:**.

## Endpoint essentials **API key access:** `api/v1/emailer_campaigns/remove_or_stop_contact_ids` or `Master API key` **OAuth scopes:**.

<Info>
  Tool ID: `apollo_remove_contacts_from_sequence`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_remove_contacts_from_sequence',
  {
    "emailer_campaign_ids": [
      "jane.doe@example.com"
    ],
    "contact_ids": [
      "contact_123"
    ],
    "mode": "finish"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute apollo_remove_contacts_from_sequence --input '{
  "emailer_campaign_ids": [
    "jane.doe@example.com"
  ],
  "contact_ids": [
    "contact_123"
  ],
  "mode": "finish"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get apollo_remove_contacts_from_sequence --json` for the complete live contract.

## Input reference

Remove or stop contacts in Apollo email sequences. Requires master API key.

| Name                           | Type                   | Required | Default | Details                                                                                           |
| ------------------------------ | ---------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `payload.emailer_campaign_ids` | `array`                | Yes      | —       | Array of sequence IDs to remove contacts from.                                                    |
| `payload.contact_ids`          | `array`                | Yes      | —       | Array of Apollo contact IDs to remove/stop.                                                       |
| `payload.mode`                 | `"finish" \| "remove"` | Yes      | —       | "finish" marks contacts as finished; "remove" removes them entirely. Allowed: `finish`, `remove`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Remove or stop contacts in Apollo email sequences. Requires master API key.",
    "properties": {
      "emailer_campaign_ids": {
        "type": "array",
        "description": "Array of sequence IDs to remove contacts from.",
        "items": {
          "type": "string"
        }
      },
      "contact_ids": {
        "type": "array",
        "description": "Array of Apollo contact IDs to remove/stop.",
        "items": {
          "type": "string"
        }
      },
      "mode": {
        "type": "string",
        "description": "\"finish\" marks contacts as finished; \"remove\" removes them entirely.",
        "enum": [
          "finish",
          "remove"
        ]
      }
    },
    "required": [
      "emailer_campaign_ids",
      "contact_ids",
      "mode"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo remove/stop contacts from sequence result.

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

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Apollo remove/stop contacts from sequence result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with `contacts`, `emailer_campaigns`, `num_contacts`, and `contact_statuses`.",
        "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](/docs/providers/apollo/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)