Update a workflow

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/workflows/{pk}/

Workflows constrain how work items move between states in a project. Update a workflow. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

pk:requiredstring (uuid)

The workflow id.

Body parameters

description:optionalstring

Free-form description.

Nullable.

is_active:optionalboolean

Whether the record is active.

name:optionalstring

Display name.

Maximum 255 characters. Nullable.

work_item_type_ids:optionalarray of string (uuid)

Ids of the work item types to associate. Replaces the current set.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

Requestable here: created_at, created_by_id, description, id, is_active, is_default, name, updated_at, updated_by_id, work_item_type_ids.

Scopes

projects.workflows:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The Workflows feature isn't on your plan, or is turned off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update a workflow

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "What this is for.",
  "is_active": true,
  "name": "Example name"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "description": "What this is for.",
        "is_active": True,
        "name": "Example name"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      description: "What this is for.",
      is_active: true,
      name: "Example name",
    }),
  },
);
const data = await response.json();

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_active": true,
  "is_default": false,
  "name": "Example name",
  "work_item_type_ids": ["d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240"]
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No workflow matches the given query."
}