---
title: "Activate or deactivate a workflow"
method: POST
path: "/appointments/workflows/{workflow_id}/toggle"
tags: ["Appointments"]
---

# Activate or deactivate a workflow

`POST /appointments/workflows/{workflow_id}/toggle`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/appointments/workflows/{workflow_id}/toggle`
- Auth: HTTP bearer

Set the workflow's active state. When deactivating (``active: false``),
all pending reminders are cancelled first (same behaviour as the in-app
toggle) so the reminder worker never fires steps for a disabled workflow.

## Path parameters

- `workflow_id` integer, required: Workflow integer ID.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ToggleWorkflowRequest
  - `active` boolean, required

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)