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

# HeyReach: Pause Campaign

> Pause a running HeyReach campaign. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Pause a running HeyReach campaign.

> [!NOTE]
>
> Tool ID: `heyreach_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(
  'heyreach_pause_campaign',
  {
    "campaign_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_pause_campaign --input '{
  "campaign_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": {
    "totalCount": 123,
    "items": [
      {
        "id": 123,
        "name": "Example",
        "creationTime": "example",
        "linkedInUserListName": "Example",
        "linkedInUserListId": 123,
        "campaignAccountIds": [
          123
        ],
        "status": "example",
        "progressStats": {
          "totalUsers": 123,
          "totalUsersInProgress": 123,
          "totalUsersPending": 123,
          "totalUsersFinished": 123,
          "totalUsersFailed": 123
        },
        "excludeAlreadyMessagedGlobal": true,
        "excludeAlreadyMessagedCampaignAccounts": true,
        "excludeFirstConnectionCampaignAccounts": true,
        "excludeFirstConnectionGlobal": true,
        "excludeNoProfilePicture": true,
        "excludeListId": null
      }
    ]
  }
}
```

Use `deepline describe heyreach_pause_campaign --json` for the latest machine-readable contract.

## Input reference

HeyReach campaign ID input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach campaign ID input.",
    "properties": {
      "campaign_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      }
    },
    "required": [
      "campaign_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.totalCount` | `integer` | Yes | — | — |
| `result.result.items` | `array` | Yes | — | — |
| `result.result.items[].id` | `integer` | Yes | — | — |
| `result.result.items[].name` | `string` | Yes | — | — |
| `result.result.items[].creationTime` | `string` | Yes | — | — |
| `result.result.items[].linkedInUserListName` | `string` | Yes | — | — |
| `result.result.items[].linkedInUserListId` | `integer` | Yes | — | — |
| `result.result.items[].campaignAccountIds` | `array` | Yes | — | — |
| `result.result.items[].status` | `string` | Yes | — | — |
| `result.result.items[].progressStats` | `object` | Yes | — | — |
| `result.result.items[].progressStats.totalUsers` | `integer` | Yes | — | — |
| `result.result.items[].progressStats.totalUsersInProgress` | `integer` | Yes | — | — |
| `result.result.items[].progressStats.totalUsersPending` | `integer` | Yes | — | — |
| `result.result.items[].progressStats.totalUsersFinished` | `integer` | Yes | — | — |
| `result.result.items[].progressStats.totalUsersFailed` | `integer` | Yes | — | — |
| `result.result.items[].excludeAlreadyMessagedGlobal` | `boolean` | Yes | — | — |
| `result.result.items[].excludeAlreadyMessagedCampaignAccounts` | `boolean` | Yes | — | — |
| `result.result.items[].excludeFirstConnectionCampaignAccounts` | `boolean` | Yes | — | — |
| `result.result.items[].excludeFirstConnectionGlobal` | `boolean` | Yes | — | — |
| `result.result.items[].excludeNoProfilePicture` | `boolean` | Yes | — | — |
| `result.result.items[].excludeListId` | `null` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "totalCount": {
            "type": "integer"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "creationTime": {
                  "type": "string"
                },
                "linkedInUserListName": {
                  "type": "string"
                },
                "linkedInUserListId": {
                  "type": "integer"
                },
                "campaignAccountIds": {
                  "type": "array",
                  "items": {
                    "type": "integer"
                  }
                },
                "status": {
                  "type": "string"
                },
                "progressStats": {
                  "type": "object",
                  "properties": {
                    "totalUsers": {
                      "type": "integer"
                    },
                    "totalUsersInProgress": {
                      "type": "integer"
                    },
                    "totalUsersPending": {
                      "type": "integer"
                    },
                    "totalUsersFinished": {
                      "type": "integer"
                    },
                    "totalUsersFailed": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "totalUsers",
                    "totalUsersInProgress",
                    "totalUsersPending",
                    "totalUsersFinished",
                    "totalUsersFailed"
                  ],
                  "additionalProperties": true
                },
                "excludeAlreadyMessagedGlobal": {
                  "type": "boolean"
                },
                "excludeAlreadyMessagedCampaignAccounts": {
                  "type": "boolean"
                },
                "excludeFirstConnectionCampaignAccounts": {
                  "type": "boolean"
                },
                "excludeFirstConnectionGlobal": {
                  "type": "boolean"
                },
                "excludeNoProfilePicture": {
                  "type": "boolean"
                },
                "excludeListId": {
                  "type": "null"
                }
              },
              "required": [
                "id",
                "name",
                "creationTime",
                "linkedInUserListName",
                "linkedInUserListId",
                "campaignAccountIds",
                "status",
                "progressStats",
                "excludeAlreadyMessagedGlobal",
                "excludeAlreadyMessagedCampaignAccounts",
                "excludeFirstConnectionCampaignAccounts",
                "excludeFirstConnectionGlobal",
                "excludeNoProfilePicture",
                "excludeListId"
              ],
              "additionalProperties": true
            }
          }
        },
        "required": [
          "totalCount",
          "items"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</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

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