Create a workspace automation

POST/api/v2/workspaces/{slug}/automations/

Workspace automations are rule graphs that run across a workspace. Create a workspace automation.

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.

Body Parameters

name:requiredstring

Human-readable automation name

Maximum 255 characters.

scope:requiredstring

The scope defines on what entity this automation runs on (e.g., WorkItem, Cycle, Module)

Maximum 50 characters.

description:optionalstring

Automation description

project_ids:optionalarray of string (uuid)

Ids of the projects to associate. Replaces the current set.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: bot_user_id, created_at, created_by_id, current_version_id, description, id, is_enabled, is_global, last_run_at, name, project_ids, run_count, scope, status, updated_at.

Scopes

automations: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 feature this endpoint belongs to isn't enabled on your plan or is switched 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	conflict	A business rule blocks the write — see the notes above.
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.

Create a workspace automation

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/automations/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "scope": "example",
  "description": "What this is for.",
  "project_ids": [
    [
      "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    ]
  ]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/automations/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Example name",
        "scope": "example",
        "description": "What this is for.",
        "project_ids": [
            [
                "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
            ]
        ]
    },
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/automations/", {
  method: "POST",
  headers: {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Example name",
    scope: "example",
    description: "What this is for.",
    project_ids: [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  }),
});
const data = await response.json();

Response201

{
  "bot_user_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "current_version_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "description": "What this is for.",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_enabled": false,
  "is_global": false,
  "last_run_at": "2026-01-14T09:22:41.478363Z",
  "name": "Example name",
  "project_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "run_count": 3,
  "scope": "example",
  "status": "draft",
  "updated_at": "2026-01-14T09:22:41.478363Z"
}