Partially update project phase

Partially updates an existing project phase. Only provided fields will be updated.

Optional fields (update only what you need):

name: Update display name
icon: Update icon identifier
type: Update phase type (affects Kanban column placement)
description: Update or clear description
translations: Update translations (partial updates supported)

Note: Fields not included in the request will remain unchanged. This is useful when you only need to update specific properties without fetching the full current state.

PATCH/administration/project-settings/phases/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

descriptionobject

Description of the project phase

iconstring

Icon for the project phase in format :icon_name:

namestring

Name of the project phase

translationsProjectPhaseTranslationDto[]

Translations for the project phase

Show properties

Array of ProjectPhaseTranslationDto

descriptionobject

Translated description of the project phase in this language. Provides context about when to use this phase.

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German)

nameobject

Translated name of the project phase in this language. Used for multilingual display in the user interface.

typestring

Type of the project phase

Allowed:newinProgressdone

Responses

200

Project phase updated successfully

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

Request body

Request

curl -X PATCH "https://leadtime.app/api/public/administration/project-settings/phases/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Initial planning and requirement gathering phase",
  "icon": ":calendar:",
  "name": "Planning",
  "translations": [
    {
      "description": "Project planning and preparation phase",
      "language": "en",
      "name": "Planning"
    }
  ],
  "type": "new"
}'

const response = await fetch("https://leadtime.app/api/public/administration/project-settings/phases/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"Initial planning and requirement gathering phase\",\n  \"icon\": \":calendar:\",\n  \"name\": \"Planning\",\n  \"translations\": [\n    {\n      \"description\": \"Project planning and preparation phase\",\n      \"language\": \"en\",\n      \"name\": \"Planning\"\n    }\n  ],\n  \"type\": \"new\"\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/administration/project-settings/phases/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"Initial planning and requirement gathering phase\",\n  \"icon\": \":calendar:\",\n  \"name\": \"Planning\",\n  \"translations\": [\n    {\n      \"description\": \"Project planning and preparation phase\",\n      \"language\": \"en\",\n      \"name\": \"Planning\"\n    }\n  ],\n  \"type\": \"new\"\n}",
)

Response

Project phase updated successfully