Update a cycle

PATCH/api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/

Updates an existing cycle by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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.

cycle_id:requiredstring

The unique identifier for the cycle.

Body Parameters

name:optionalstring

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:optionalstring

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.

Update a cycle

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

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/",
    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'
}
)
print(response.json())

const response = await fetch(
  'https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/',
  {
    method: 'PATCH',
    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',
    }),
  },
);
const data = await response.json();

Response200

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