Update project

PATCH/workspaces/{organizationId}/projects/{id}

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

namestring

min length 1

descriptionstring

statusstring

healthstring

Allowed:on_trackat_riskoff_trackpaused

leadIdstring

archivedAtstring

startDatestring

endDatestring

Responses

200Project updated

idstringrequired

organizationIdstringrequired

namestringrequired

descriptionstring | nullrequired

statusstringrequired

healthstringrequired

Allowed:on_trackat_riskoff_trackpaused

leadIdstring | nullrequired

archivedAtstring | nullrequired

startDatestring | nullrequired

endDatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

namestringdescriptionstringstatusstringhealthstringleadIdstringarchivedAtstringstartDatestringendDatestring

Request

curl -X PATCH "/workspaces/string/projects/string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "status": "string",
  "health": "on_track",
  "leadId": "string",
  "archivedAt": "string",
  "startDate": "string",
  "endDate": "string"
}'

const response = await fetch("/workspaces/string/projects/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"status\": \"string\",\n  \"health\": \"on_track\",\n  \"leadId\": \"string\",\n  \"archivedAt\": \"string\",\n  \"startDate\": \"string\",\n  \"endDate\": \"string\"\n}"
});

import requests

response = requests.patch(
    "/workspaces/string/projects/string",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"status\": \"string\",\n  \"health\": \"on_track\",\n  \"leadId\": \"string\",\n  \"archivedAt\": \"string\",\n  \"startDate\": \"string\",\n  \"endDate\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "health": "on_track",
  "leadId": "string",
  "archivedAt": "string",
  "startDate": "string",
  "endDate": "string",
  "createdAt": "string",
  "updatedAt": "string"
}