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

# Pause Campaign

> Pause an active campaign. No more emails will be sent until resumed.

## Path Parameters

<ParamField path="campaign_id" type="string" required>
  The unique identifier of the campaign.
</ParamField>

## Response

Returns the updated campaign object with `status: "paused"`.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://api.foxreach.io/api/v1/campaigns/cmp_abc123/pause" \
    -H "X-API-Key: otr_your_key"
  ```

  ```python Python SDK theme={null}
  from foxreach import FoxReach

  client = FoxReach(api_key="otr_your_key")
  campaign = client.campaigns.pause("cmp_xyz789")
  ```

  ```typescript TypeScript SDK theme={null}
  import { FoxReach } from "foxreach";

  const client = new FoxReach({ apiKey: "otr_your_key" });
  const campaign = await client.campaigns.pause("cmp_xyz789");
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "data": {
      "id": "cmp_abc123",
      "name": "Q1 Outreach",
      "status": "paused",
      "..."
    }
  }
  ```
</ResponseExample>

## Errors

| Status | Description                         |
| ------ | ----------------------------------- |
| `400`  | Only active campaigns can be paused |
| `404`  | Campaign not found                  |

<Note>
  Pausing a campaign stops all scheduled email sends. Leads that are mid-sequence will resume from where they left off when you start the campaign again.
</Note>

## Rate Limit

* **100 requests per minute, per API key.** Fixed 60-second window.
* Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` (unix epoch seconds).
* A `429` response includes a `Retry-After` header (seconds until the bucket resets).

For client-side patterns (`Retry-After`, exponential backoff, monitoring `X-RateLimit-Remaining`), see [Rate Limiting](/rate-limiting).
