Create a cycle

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

Creates a new cycle 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 cycle.

description:optionalstring

Description of the cycle.

start_date:optionalstring

Start date of the cycle in YYYY-MM-DD format.

end_date:optionalstring

End date of the cycle in YYYY-MM-DD format.

owned_by:requiredstring

ID of the user who owns the cycle.

external_source:optionalstring

External source identifier.

external_id:optionalstring

External ID from the external source.

timezone:optionalstring

Timezone for the cycle.

project_id:requiredstring

ID of the project for the cycle.

Create a cycle

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "example-description",
  "start_date": "example-start_date",
  "end_date": "example-end_date",
  "owned_by": "example-owned_by",
  "external_source": "example-external_source",
  "external_id": "example-external_id",
  "timezone": "example-timezone",
  "project_id": "example-project_id"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description': 'example-description',
  'start_date': 'example-start_date',
  'end_date': 'example-end_date',
  'owned_by': 'example-owned_by',
  'external_source': 'example-external_source',
  'external_id': 'example-external_id',
  'timezone': 'example-timezone',
  'project_id': 'example-project_id'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "description": "example-description",
  "start_date": "example-start_date",
  "end_date": "example-end_date",
  "owned_by": "example-owned_by",
  "external_source": "example-external_source",
  "external_id": "example-external_id",
  "timezone": "example-timezone",
  "project_id": "example-project_id"
})
  }
);
const data = await response.json();

Response201

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