Create a state

POST/api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/

Creates a new state in a project.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

project_id:requiredstring

The unique identifier of the project.

Body Parameters

name:requiredstring

Name of the state.

color:requiredstring

Hex color code for the state (e.g., "#eb5757").

Create a state

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "color": "example-color"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'color': 'example-color'
}
)
print(response.json())

const response = await fetch('https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'example-name',
    color: 'example-color',
  }),
});
const data = await response.json();

Response201

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}