Create cycle

POST/workspaces/{organizationId}/cycles

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

projectIdstring

namestringrequired

min length 1

numberinteger

statusstring

Allowed:upcomingactivecompleted

autoRolloverboolean

archivedAtstring

startDatestring<date> | string<date-time>

Show properties

Any of:

string<date>

string<date>

string<date-time>

string<date-time>

endDatestring<date> | string<date-time>

Show properties

Any of:

string<date>

string<date>

string<date-time>

string<date-time>

Responses

201

Cycle created

idstringrequired

organizationIdstringrequired

projectIdstring | nullrequired

namestringrequired

numbernumber | nullrequired

statusstringrequired

Allowed:upcomingactivecompleted

autoRolloverbooleanrequired

archivedAtstring | nullrequired

startDatestring | nullrequired

endDatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

projectIdstringnamestring*numberintegerstatusstringautoRolloverbooleanarchivedAtstringstartDatestringendDatestring

Request

curl -X POST 'https://pile.nyc/workspaces/string/cycles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "projectId": "string",
  "name": "string",
  "number": 0,
  "status": "upcoming",
  "autoRollover": true,
  "archivedAt": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}'

const response = await fetch("https://pile.nyc/workspaces/string/cycles", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "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\": \"2019-08-24\",\n  \"endDate\": \"2019-08-24\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/cycles",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "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\": \"2019-08-24\",\n  \"endDate\": \"2019-08-24\"\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"
}