---
title: "Activate or update a workflow"
method: POST
path: "/api/v2/agent/activatePlaybook"
tags: ["Agent"]
---

# Activate or update a workflow

`POST /api/v2/agent/activatePlaybook`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v2/agent/activatePlaybook`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

Activate a workflow template for the organization, or update the existing instance for that template. The request can choose modelStrength for the activation job and any generated event triggers.

## Request body

- AgentActivatePlaybookRequest
  - `organizationId` string: Organization ID (injected by MCP server)
  - `templateId` string, uuid, required: Workflow template ID from agent.listPlaybookTemplates.
  - `parameterValues` object, required: Values for the template parameterSchema.
  - `modelStrength` 'LOW' | 'HIGH': Model strength for the activation job and generated triggers. Omit to use LOW. LOW is suitable for the vast majority of tasks; HIGH is for unusually complex work.
  - `selectedTriggerIndices` integer[]: Indices from the template suggestedTriggers array to create. Omit to create every suggested trigger.

## Response `200`

Activated workflow instance

- AgentActivatePlaybookResponse
  - `instance` object, required
    - `id` string, uuid, required
    - `status` 'ACTIVE' | 'PAUSED' | 'UNINSTALLED', required
    - `parameterValues` object, required
    - `modelStrength` 'LOW' | 'HIGH', required
    - `conversationId` string, uuid, nullable
    - `template` object, required
      - `id` string, uuid, required
      - `slug` string, required
      - `name` string, required
      - `description` string, required
      - `category` 'SCA' | 'SAST' | 'CONTAINER' | 'INCIDENT_RESPONSE' | 'COMPLIANCE' | 'GENERAL', required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Error Response
- `401`: Error Response
- `404`: Error Response
- `412`: Error Response

---

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