> ## 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: Archive Sequence

> Archive an Apollo sequence so it stops and is hidden from active sequences. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Archive an Apollo sequence so it stops and is hidden from active sequences.

> [!NOTE]
>
> Tool ID: `apollo_archive_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_archive_sequence',
  {
    "emailer_campaign_id": "jane.doe@example.com"
  },
);

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

### CLI

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

## Example response

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

## Input reference

Archive an Apollo email sequence. Completes all enrolled contacts and marks the sequence as archived. Requires master API key.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.emailer_campaign_id` | `string` | Yes | — | The Apollo sequence ID to archive. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Archive an Apollo email sequence. Completes all enrolled contacts and marks the sequence as archived. Requires master API key.",
    "properties": {
      "emailer_campaign_id": {
        "type": "string",
        "description": "The Apollo sequence ID to archive."
      }
    },
    "required": [
      "emailer_campaign_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo archive sequence result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `record` | Yes | — | Payload with the archived `emailer_campaign` object. |
| `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 archive sequence result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Payload with the archived `emailer_campaign` object.",
        "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.