---
title: "Pause a workflow"
description: "Nothing new starts until a version is activated again."
canonical: "https://grid82.com/docs/app-api/my/workflows-pause"
updated: "2026-11-13"
---

# Pause a workflow

`POST https://your-suite.grid82.app/your-app/v1/workflows/{workflowId}/pause`

Nothing new starts until a version is activated again.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

Runs already started carry on.

Requires the `workflows:write` scope. Operation `my.workflows.pause`. MCP tool `my_workflows_pause`. CLI: `grid82 my workflows pause` (`npx grid82`).

## Path parameters

| Name         | Type   | Required | Description |
| ------------ | ------ | -------- | ----------- |
| `workflowId` | string | yes      |             |

## Headers

| Name              | Type   | Required | Description                                                                                                                                                                                                                                                        |
| ----------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Idempotency-Key` | string | no       | Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters. |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.id` (`string`, required)
- `data.status` (`string`, required)

```json
{
  "data": {
    "id": "<string>",
    "status": "<string>"
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

```json
{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}
```

**Example request**

```bash
curl --request POST \
  --url 'https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause' \
  --header 'Authorization: Bearer <token>'
```