Update a state

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

Update some properties of a workflow state, such as its name, color, or group. Fields you leave out stay unchanged.

Path parameters

project_id:requiredstring

The unique identifier of the project.

workspace_slug:requiredstring

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

state_id:requiredstring

The unique identifier of the state.

Body parameters

name:optionalstring

The state's name.

description:optionalstring

The state's description.

color:optionalstring

Display color as a hex code.

sequence:optionalnumber

Position used to order the state in the workflow.

group:optionalstring

The state group: backlog, unstarted, started, completed, cancelled, or triage.

is_triage:optionalboolean

Whether the state is a triage state.

default:optionalboolean

Whether this is the project's default state.

external_source:optionalstring

The system external_id came from, for example github or jira.

external_id:optionalstring

Your system's identifier for this record, for sync and import correlation.

Scopes

projects.states:write

Update a state

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/state-uuid/" \
  -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/project-uuid/states/state-uuid/",
    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/project-uuid/states/state-uuid/",
  {
    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"
}