---
title: "Toggle Pause Agent"
method: POST
path: "/campaigns/pause/{agent_module_id}"
tags: ["authenticated", "campaigns"]
---

# Toggle Pause Agent

`POST /campaigns/pause/{agent_module_id}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/campaigns/pause/{agent_module_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Pause or unpause all campaigns for an agent module.

If any campaign is active, pause all. If all are paused, unpause all.

## Path parameters

- `agent_module_id` string, required

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- ToggleCampaignPauseRequest
  - `include_todays_send` boolean

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)