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

# Instantly: Pause Campaign

> Pause sending for an Instantly campaign by its campaign ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Pause sending for an Instantly campaign by its campaign ID.

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

## 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(
  'instantly_pause_campaign',
  {
    "id": "id_123",
    "campaign_id": "campaign_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute instantly_pause_campaign --input '{
  "id": "id_123",
  "campaign_id": "campaign_123"
}' --json
```

## Example response

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

## Input reference

Pause an Instantly campaign.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | No | — | Minimum length: 1. |
| `payload.campaign_id` | `string` | No | — | Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Pause an Instantly campaign.",
    "minProperties": 1,
    "properties": {
      "id": {
        "type": "string",
        "minLength": 1
      },
      "campaign_id": {
        "type": "string",
        "minLength": 1
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Raw Instantly pause campaign response.

The static output schema is not available. Run `deepline describe instantly_pause_campaign --json` for the live contract.

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "description": "Raw Instantly pause campaign response."
  }
  ```
</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

* [Instantly provider guide](https://deepline.com/docs/providers/instantly/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.