Workspace

Create a workflow state

Add a workflow state to a project.

post/workspaces/{workspace_slug}/projects/{project_id}/states/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: projects.states:write)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

project_idstring uuid required

The project the resource belongs to.

Request body

namestring required
colorstring required

Hex colour, e.g. #3f76ff.

descriptionstring
group'backlog' | 'unstarted' | 'started' | 'completed' | 'cancelled'
sequencenumber
defaultboolean
is_triageboolean
external_sourcestring
external_idstring

Response

The created workflow state.

idstring uuid required
namestring required
colorstring
group'backlog' | 'unstarted' | 'started' | 'completed' | 'cancelled'
descriptionstring nullable
sequencenumber
defaultboolean
is_triageboolean
projectstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.