---
title: "Pause Playbook"
method: POST
path: "/v1/playbooks/{playbook_id}/pause"
tags: ["playbooks"]
---

# Pause Playbook

`POST /v1/playbooks/{playbook_id}/pause`

## Request

- Base URL: `https://api.topo.io`
- URL: `https://api.topo.io/v1/playbooks/{playbook_id}/pause`
- Auth: HTTP bearer

Pause an active playbook, suspending automated runs.

Requires the `sequences:write` scope on the API key.

## Path parameters

- `playbook_id` string, uuid, required

## Response `200`

Successful Response

- SetPlaybookStatusPublicOutput
  - `playbook_id` string, uuid, required: Playbook whose status changed.
  - `previous_status` 'DRAFT' | 'ENABLED' | 'PAUSED', required
  - `new_status` 'DRAFT' | 'ENABLED' | 'PAUSED', required

## Changes

- **2026-08-15** `80f4fd40b75e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/topo/apis/topo-public-api/changes/v1/playbooks/:playbook_id/pause/post.md)

---

[API](https://skmtc.dev/topo/apis/topo-public-api.md) · [All operations](https://skmtc.dev/topo/apis/topo-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/topo/apis/topo-public-api/revisions/62914910b2a8?raw)