Create cycle

POST/workspaces/{organizationId}/cycles

Path parameters

organizationIdstringrequired

Request body

application/json

projectIdstring

namestringrequired

min length 1

numberinteger

statusstring

Allowed:upcomingactivecompleted

autoRolloverboolean

archivedAtstring

startDatestring

endDatestring

Responses

201Cycle created

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*

Bodyapplication/json

projectIdstringnamestring*numberintegerstatusstringautoRolloverbooleanarchivedAtstringstartDatestringendDatestring

Request

curl -X POST "/workspaces/string/cycles" \
  -H "Content-Type: application/json" \
  -d '{
  "projectId": "string",
  "name": "string",
  "number": 0,
  "status": "upcoming",
  "autoRollover": true,
  "archivedAt": "string",
  "startDate": "string",
  "endDate": "string"
}'

const response = await fetch("/workspaces/string/cycles", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"projectId\": \"string\",\n  \"name\": \"string\",\n  \"number\": 0,\n  \"status\": \"upcoming\",\n  \"autoRollover\": true,\n  \"archivedAt\": \"string\",\n  \"startDate\": \"string\",\n  \"endDate\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/cycles",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"projectId\": \"string\",\n  \"name\": \"string\",\n  \"number\": 0,\n  \"status\": \"upcoming\",\n  \"autoRollover\": true,\n  \"archivedAt\": \"string\",\n  \"startDate\": \"string\",\n  \"endDate\": \"string\"\n}",
)

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"
}