Partially update task status

Updates specific fields of an existing task status without requiring all fields.

What can be updated: Any combination of the following (all optional):

Status name
Icon
Status type
Multilingual translations

How it works: Only provide the fields you want to update. Fields not provided will remain unchanged. This is useful when you only need to update one aspect of a status (e.g., just the icon or just the name).

Example use cases:

Update only the status icon
Add or update translations without changing other fields
Change status type while keeping name and icon

Note: This endpoint merges provided fields with existing values, unlike PUT which requires all fields.

PATCH/administration/task-settings/statuses/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Request body

requiredapplication/json

iconstring

Icon for the task status in format :icon_name: (e.g., :hourglass_flowing_sand:, :check_mark:, :x:)

namestring

Name of the task status

translationsTaskStatusTranslationDto[]

Translations for the task status

Show properties

Array of TaskStatusTranslationDto

languagestringrequired

Language code (e.g., "en", "de")

namestringrequired

Translated name of the task status

typestring

Type of the task status

Allowed:NewInProgressFeedbackBacklogResolvedClosed

Responses

200

Task status updated successfully

iconstringrequired

Icon for the task status in format :icon_name: (e.g., :hourglass_flowing_sand:, :check_mark:, :x:)

idstringrequired

Unique identifier of the task status

namestringrequired

Name of the task status

sortnumberrequired

Sort order of the task status

translationsTaskStatusTranslationDto[]required

Translations for the task status

Show properties

Array of TaskStatusTranslationDto

languagestringrequired

Language code (e.g., "en", "de")

namestringrequired

Translated name of the task status

typestringrequired

Type of the task status

Allowed:NewInProgressFeedbackBacklogResolvedClosed

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*fieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Bodyapplication/json

Request body

Request

curl -X PATCH "https://leadtime.app/api/public/administration/task-settings/statuses/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "icon": ":hourglass_flowing_sand:",
  "name": "In Progress",
  "translations": [
    {
      "language": "en",
      "name": "In Progress"
    },
    {
      "language": "de",
      "name": "In Bearbeitung"
    }
  ],
  "type": "InProgress"
}'

const response = await fetch("https://leadtime.app/api/public/administration/task-settings/statuses/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"icon\": \":hourglass_flowing_sand:\",\n  \"name\": \"In Progress\",\n  \"translations\": [\n    {\n      \"language\": \"en\",\n      \"name\": \"In Progress\"\n    },\n    {\n      \"language\": \"de\",\n      \"name\": \"In Bearbeitung\"\n    }\n  ],\n  \"type\": \"InProgress\"\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/administration/task-settings/statuses/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"icon\": \":hourglass_flowing_sand:\",\n  \"name\": \"In Progress\",\n  \"translations\": [\n    {\n      \"language\": \"en\",\n      \"name\": \"In Progress\"\n    },\n    {\n      \"language\": \"de\",\n      \"name\": \"In Bearbeitung\"\n    }\n  ],\n  \"type\": \"InProgress\"\n}",
)

Response

{
  "icon": ":hourglass_flowing_sand:",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "In Progress",
  "sort": 1,
  "translations": [
    {
      "language": "en",
      "name": "In Progress"
    },
    {
      "language": "de",
      "name": "In Bearbeitung"
    }
  ],
  "type": "InProgress"
}