Create cycle start today

POST/workspaces/{organizationId}/cycles/{id}/start-today

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200Cycle started today

idstringrequired

organizationIdstringrequired

projectIdstring | nullrequired

namestringrequired

numbernumber | nullrequired

statusstringrequired

Allowed:upcomingactivecompleted

autoRolloverbooleanrequired

archivedAtstring | nullrequired

startDatestring | nullrequired

endDatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Request

curl -X POST "/workspaces/string/cycles/string/start-today"

const response = await fetch("/workspaces/string/cycles/string/start-today", {
  method: "POST"
});

import requests

response = requests.post(
    "/workspaces/string/cycles/string/start-today",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "projectId": "string",
  "name": "string",
  "number": 0,
  "status": "upcoming",
  "autoRollover": true,
  "archivedAt": "string",
  "startDate": "string",
  "endDate": "string",
  "createdAt": "string",
  "updatedAt": "string"
}