Tool reference · Workspace

pause_campaign

Pause a campaign by id

writesreads the workspacenot rate limited

Updated 2026-09-18 · Server 2.0.0

What it does

Stop a campaign from sending. The only tool that writes anything, and the reason the endpoint is worth connecting rather than just reading from.

Arguments

NameTypeRequiredMeaning
idstringyes

This table is generated from the literal inputSchema that tools/list returns, so what your client sees and what this page says are the same object:

inputSchema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Request

Paste this, swap the key, and you have called the tool.

curl
curl -s https://topclozer.com/api/mcp \
  -H "Authorization: Bearer tcz_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "pause_campaign",
      "arguments": { "id": "cmp_7f21a0" }
    }
  }'

Returns

{ "ok": true } when a campaign with that id was found and paused; { "ok": false } when no campaign matched. It does not error on an unknown id — check the flag.

The payload arrives inside an MCP content block — one text block whose body is this JSON, pretty-printed. Parse the string; there is no structured-content field.

payload
{ "ok": true }

Worth knowing

Idempotent: pausing an already-paused campaign returns ok: true and changes nothing. There is no resume tool — restarting a campaign is a deliberate human action in the app.

Limits

No request limit. This tool reads the workspace database and costs nothing to serve. The limits that bite in this product are the sending controls — per-sender weekly invite caps, the warm-up ramp, the working-hours window and a randomised gap between actions — and no tool can raise them.

Related tools

All 21 tools are listed on the tool index. Connecting a client is on the Claude setup page, and the protocol details are on the server page.