Update a cycle

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

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

Update a cycle

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "owned_by": "<string>",
  "external_source": "<string>",
  "external_id": "<string>",
  "timezone": "<string>"
}
'

Path parameters

workspace_slug · string · required

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 · string · required

The unique identifier of the project.

cycle_id · string · required

The unique identifier for the cycle.

Body parameters

name · string

Name of the cycle.

description · string

Description of the cycle.

start_date · string

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

end_date · string

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

owned_by · string

ID of the user who owns the cycle.

external_source · string

External source identifier.

external_id · string

External ID from the external source.

timezone · string

Timezone for the cycle.