Create a workflow state

POST/api/v2/workspaces/{slug}/projects/{project_id}/workflows/{workflow_id}/states/

Attach project states to a project workflow. Send the ids of states that belong to the project. A new workflow state starts as a transition state that allows work item creation. States already on the workflow come back unchanged.

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.

workflow_id:requiredstring (uuid)

The workflow the resource belongs to.

Body Parameters

state_ids:requiredarray of string (uuid)

The ids of the project states to attach. Must not be empty. An id that isn't a state in this project is a 400.

To change type, allow_issue_creation or is_default, update the workflow state after you attach it.

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: allow_issue_creation, created_at, created_by_id, id, is_default, state_id, type, updated_at, updated_by_id, workflow_id.

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.

Create a workflow state

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "state_ids": [
    "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
    "3c8e1f47-92ab-4d65-b0f1-7a2d9e4c6b18"
  ]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/workflows/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/states/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "state_ids": [
            "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
            "3c8e1f47-92ab-4d65-b0f1-7a2d9e4c6b18",
        ]
    },
)
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/states/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      state_ids: ["f960d3c2-8524-4a41-b8eb-055ce4be2a7f", "3c8e1f47-92ab-4d65-b0f1-7a2d9e4c6b18"],
    }),
  },
);
const data = await response.json();

Response201

[
  {
    "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
    "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
    "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
    "type": "transition",
    "allow_issue_creation": true,
    "is_default": true,
    "created_at": "2026-01-12T15:04:10.478363Z",
    "updated_at": "2026-01-13T08:30:55.478363Z",
    "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
    "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
  },
  {
    "id": "5d2a8c71-0e4f-4b39-a6d8-1f7c3e9b2a40",
    "state_id": "3c8e1f47-92ab-4d65-b0f1-7a2d9e4c6b18",
    "workflow_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
    "type": "transition",
    "allow_issue_creation": true,
    "is_default": false,
    "created_at": "2026-01-14T09:22:41.478363Z",
    "updated_at": "2026-01-14T09:22:41.478363Z",
    "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
    "updated_by_id": null
  }
]