> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.heyreach.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server.

# Pause

POST https://api//api/public/campaign/Pause?campaignId=<long>

Pauses the specified campaign.

Reference: https://docs.heyreach.io/hey-reach-api/campaigns/pause

## Request

### Query parameters

- `campaignId` (string, optional)

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

## Response

### 200

OK

- `totalCount` (string, required)
- `items` (list of object, required)
  - `id` (string, required)
  - `name` (string, required)
  - `creationTime` (string, required)
  - `linkedInUserListName` (string, required)
  - `linkedInUserListId` (string, required)
  - `campaignAccountIds` (list of string, required)
  - `progressStats` (object, required)
    - `totalUsers` (string, required)
    - `totalUsersInProgress` (string, required)
    - `totalUsersPending` (string, required)
    - `totalUsersFinished` (string, required)
    - `totalUsersFailed` (string, required)
  - `excludeAlreadyMessagedGlobal` (string, required)
  - `excludeAlreadyMessagedCampaignAccounts` (string, required)
  - `excludeFirstConnectionCampaignAccounts` (string, required)
  - `excludeFirstConnectionGlobal` (string, required)
  - `excludeNoProfilePicture` (string, required)
  - `excludeListId` (string, required)
  - `status` (any, optional, nullable)

## Errors

### 400 Pause Campaigns Request Bad Request Error

Bad Request

- `errorMessage` (string, required)

### 401 Pause Campaigns Request Unauthorized Error

Unauthorized

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

### 404 Pause Campaigns Request Not Found Error

Not Found

- `errorMessage` (string, required)

### 429 Pause Campaigns Request Too Many Requests Error

Too Many Requests

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

## Examples

**Response**

```json
{
  "totalCount": "<integer>",
  "items": [
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    },
    {
      "id": "<long>",
      "name": "<string>",
      "creationTime": "<dateTime>",
      "linkedInUserListName": "<string>",
      "linkedInUserListId": "<long>",
      "campaignAccountIds": [
        "<integer>",
        "<integer>"
      ],
      "progressStats": {
        "totalUsers": "<integer>",
        "totalUsersInProgress": "<integer>",
        "totalUsersPending": "<integer>",
        "totalUsersFinished": "<integer>",
        "totalUsersFailed": "<integer>"
      },
      "excludeAlreadyMessagedGlobal": "<boolean>",
      "excludeAlreadyMessagedCampaignAccounts": "<boolean>",
      "excludeFirstConnectionCampaignAccounts": "<boolean>",
      "excludeFirstConnectionGlobal": "<boolean>",
      "excludeNoProfilePicture": "<boolean>",
      "excludeListId": "<long>"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/campaign/Pause"

querystring = {"campaignId":"<long>"}

headers = {"X-API-KEY": "<string>"}

response = requests.post(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api//api/public/campaign/Pause?campaignId=%3Clong%3E';
const options = {method: 'POST', headers: {'X-API-KEY': '<string>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api//api/public/campaign/Pause?campaignId=%3Clong%3E"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-KEY", "<string>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api//api/public/campaign/Pause?campaignId=%3Clong%3E")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<string>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api//api/public/campaign/Pause?campaignId=%3Clong%3E")
  .header("X-API-KEY", "<string>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api//api/public/campaign/Pause?campaignId=%3Clong%3E', [
  'headers' => [
    'X-API-KEY' => '<string>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/campaign/Pause?campaignId=%3Clong%3E");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-KEY", "<string>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-KEY": "<string>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/campaign/Pause?campaignId=%3Clong%3E")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```