Update product category

Updates all fields of an existing product category. All fields must be provided.

What can be updated:

Name: Display name of the category
Icon: Icon in format :icon_name: (e.g., :computer:, :package:)
Description: Optional description of the category
Translations: Multilingual name and description translations

Icon format:

Use emoji-style format: :icon_name:
Examples: :computer:, :desktop_computer:, :money_with_wings:, :office_worker:

Multilingual support:

Provide complete translations array with language codes
Each translation can have a translated name and description
Translations appear automatically in multilingual user interfaces and documents

Note: This endpoint requires the manageSettings permission. Use PATCH endpoint if you only want to update specific fields. All fields are required in PUT requests.

PUT/administration/product-categories/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

descriptionobject

Optional description explaining what products or services belong to this category. Helps users understand the category purpose when creating or assigning products. All fields are required in PUT requests.

iconstring

Icon identifier for the product category in emoji-style format :icon_name:. Icons help visually distinguish categories in lists and dropdowns. Examples: :computer:, :desktop_computer:, :money_with_wings:, :office_worker:, :package:. All fields are required in PUT requests.

namestring

Display name of the product category. This is the primary name used to identify and organize products. Examples: "Hardware", "Software", "Consulting", "Subscriptions". All fields are required in PUT requests.

translationsProductCategoryTranslationDto[]

Array of translations for multilingual support. Each translation provides the category name and description in a specific language. Translations are automatically used in multilingual user interfaces and documents based on the user language preference. Common languages: "en" (English), "de" (German). All fields are required in PUT requests.

Show properties

Array of ProductCategoryTranslationDto

descriptionobject

Translated description of the product category in the specified language. This description appears in multilingual user interfaces and documents when the user language matches.

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German). This determines which language interface will display this translation.

nameobject

Translated name of the product category in the specified language. This name appears in multilingual user interfaces and documents when the user language matches.

Responses

200

Product category updated successfully

createdAtstring<date-time>required

ISO 8601 timestamp indicating when the product category was created. Format: YYYY-MM-DDTHH:mm:ss.sssZ

defaultKeyobject

Default key identifier for system-defined categories (e.g., "software", "hardware", "consulting", "external_costs"). Only present for categories that were created from system defaults. Custom categories created by users do not have a defaultKey. This key is used when restoring default categories.

deletedAtobject

ISO 8601 timestamp indicating when the product category was soft-deleted, or null if not deleted. Format: YYYY-MM-DDTHH:mm:ss.sssZ. Soft-deleted categories are marked as deleted but not permanently removed.

descriptionobject

Optional description explaining what products or services belong to this category. Helps users understand the category purpose when creating or assigning products.

iconstringrequired

Icon identifier for the product category in emoji-style format :icon_name:. Icons help visually distinguish categories in lists and dropdowns.

idstringrequired

Unique identifier (UUID) of the product category. Use this ID to reference the category in other API calls.

namestringrequired

Display name of the product category. This is the primary name used to identify and organize products.

sortnumber

Numeric sort order for displaying categories. Lower numbers appear first. Used to control the order in which categories appear in dropdowns and lists.

translationsProductCategoryTranslationDto[]required

Show properties

Array of ProductCategoryTranslationDto

descriptionobject

Translated description of the product category in the specified language. This description appears in multilingual user interfaces and documents when the user language matches.

languagestringrequired

ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German). This determines which language interface will display this translation.

nameobject

Translated name of the product category in the specified language. This name appears in multilingual user interfaces and documents when the user language matches.

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 PUT "https://leadtime.app/api/public/administration/product-categories/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Software products and licenses",
  "icon": ":package:",
  "name": "Software",
  "translations": [
    {
      "description": "Software products and licenses",
      "language": "en",
      "name": "Software"
    }
  ]
}'

const response = await fetch("https://leadtime.app/api/public/administration/product-categories/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"Software products and licenses\",\n  \"icon\": \":package:\",\n  \"name\": \"Software\",\n  \"translations\": [\n    {\n      \"description\": \"Software products and licenses\",\n      \"language\": \"en\",\n      \"name\": \"Software\"\n    }\n  ]\n}"
});

import requests

response = requests.put(
    "https://leadtime.app/api/public/administration/product-categories/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"Software products and licenses\",\n  \"icon\": \":package:\",\n  \"name\": \"Software\",\n  \"translations\": [\n    {\n      \"description\": \"Software products and licenses\",\n      \"language\": \"en\",\n      \"name\": \"Software\"\n    }\n  ]\n}",
)

Response

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "defaultKey": "software",
  "deletedAt": null,
  "description": "Software products and licenses",
  "icon": ":package:",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Software",
  "sort": 1,
  "translations": [
    {
      "description": "Software products and licenses",
      "language": "en",
      "name": "Software"
    },
    {
      "description": "Softwareprodukte und Lizenzen",
      "language": "de",
      "name": "Software"
    }
  ]
}