Update a state

PATCH/api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/

Partially update an existing workflow state's properties like name, color, or group.

Path Parameters

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

state_id:requiredstring

State ID

Body Parameters

name:optionalstring

Name.

description:optionalstring

Description.

color:optionalstring

Color.

sequence:optionalnumber

Sequence.

group:optionalstring

• backlog - Backlog
• unstarted - Unstarted
• started - Started
• completed - Completed
• cancelled - Cancelled
• triage - Triage

is_triage:optionalboolean

Is triage.

default:optionalboolean

Default.

external_source:optionalstring

External source.

external_id:optionalstring

External id.

Scopes

projects.states:write

Update a state

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Name",
  "color": "#00ff00",
  "group": "backlog",
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "external_source": "github"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Example Name",
      "color": "#00ff00",
      "group": "backlog",
      "external_id": "550e8400-e29b-41d4-a716-446655440000",
      "external_source": "github"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Example Name",
      color: "#00ff00",
      group: "backlog",
      external_id: "550e8400-e29b-41d4-a716-446655440000",
      external_source: "github",
    }),
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "color": "#f39c12",
  "group": "started",
  "sequence": 2,
  "default": false,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}