Update project custom field

Updates an existing project custom field. All fields must be provided (full replacement).

Required fields:

name: Updated display name
type: Field type enum value
translations: Complete translations array (all languages)

Optional fields:

description: Updated description
selectOptions: Updated options array (required for Select and MultiSelect types)
translationsDescriptions: Updated description translations

Important:

Changing field type may cause data loss if existing values are incompatible
For Select/MultiSelect types, all options must be included in the request
Removing options that are in use may cause validation errors

Note: This is a full update operation. Use PATCH endpoint if you only want to update specific fields.

PUT/administration/project-settings/custom-fields/{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

descriptionstring

Description of the custom field

namestringrequired

Name of the custom field

selectOptionsProjectCustomFieldSelectOptionDto[]

Select options (required for Select type fields)

Show properties

Array of ProjectCustomFieldSelectOptionDto

idstring

Optional unique identifier for the select option. If not provided, the value will be used as the identifier. Required when updating existing options.

translationsProjectCustomFieldSelectOptionTranslationDto[]required

Array of translations for multilingual support. Each translation contains a language code and translated display name. The system automatically shows the correct language based on user preferences.

Show properties

Array of ProjectCustomFieldSelectOptionTranslationDto

languagestringrequired

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

namestringrequired

Translated display name for the select option in this language. Shown to users when selecting from dropdown options.

valuestringrequired

Display value for the select option. This is the value stored when the option is selected. Must be unique within the field.

translationsProjectCustomFieldTranslationDto[]required

Translations for the custom field name

Show properties

Array of ProjectCustomFieldTranslationDto

descriptionstring

Translated description of the custom field in this language. Provides context about what information should be entered.

languagestringrequired

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

namestring

Translated name of the custom field in this language. Used for multilingual display in project forms.

translationsDescriptionsProjectCustomFieldTranslationDto[]

Translations for the custom field description

Show properties

Array of ProjectCustomFieldTranslationDto

descriptionstring

Translated description of the custom field in this language. Provides context about what information should be entered.

languagestringrequired

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

namestring

Translated name of the custom field in this language. Used for multilingual display in project forms.

typestringrequired

Type of the custom field

Allowed:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl

Responses

200

Project custom field updated successfully

descriptionstringrequired

Description providing context about what information should be entered in this field.

entitystringrequired

Entity type identifier. Always "Project" for project custom fields. Used internally to scope fields to specific entity types.

idstringrequired

Unique identifier (UUID) for the custom field. Used to reference this field when setting values on projects.

namestringrequired

Display name of the custom field. Shown as the field label in project forms.

selectOptionsProjectCustomFieldSelectOptionDto[]required

Array of select options for Select and MultiSelect field types. Each option contains an ID, value, and translations. Empty array for other field types.

Show properties

Array of ProjectCustomFieldSelectOptionDto

idstring

Optional unique identifier for the select option. If not provided, the value will be used as the identifier. Required when updating existing options.

translationsProjectCustomFieldSelectOptionTranslationDto[]required

Array of translations for multilingual support. Each translation contains a language code and translated display name. The system automatically shows the correct language based on user preferences.

Show properties

Array of ProjectCustomFieldSelectOptionTranslationDto

languagestringrequired

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

namestringrequired

Translated display name for the select option in this language. Shown to users when selecting from dropdown options.

valuestringrequired

Display value for the select option. This is the value stored when the option is selected. Must be unique within the field.

sortnumberrequired

Numeric sort order for display purposes. Lower numbers appear first in project forms. Determines the order in which fields are displayed.

translationsProjectCustomFieldTranslationDto[]required

Complete array of translations for the field name. Each translation contains the language code and localized name.

Show properties

Array of ProjectCustomFieldTranslationDto

descriptionstring

Translated description of the custom field in this language. Provides context about what information should be entered.

languagestringrequired

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

namestring

Translated name of the custom field in this language. Used for multilingual display in project forms.

typestringrequired

Field type enum value indicating the input type. Valid values: Text, Textarea, Number, Date, Checkbox, Select, MultiSelect.

Allowed:TextTextareaNumberDateCheckboxSelectMultiSelectCurrencyUrl

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 PUT "https://leadtime.app/api/public/administration/project-settings/custom-fields/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Priority level for the project",
  "name": "Priority Level",
  "selectOptions": [
    {
      "id": "option-1",
      "translations": [
        {
          "language": "en",
          "name": "High Priority"
        },
        {
          "language": "de",
          "name": "Hohe Priorität"
        }
      ],
      "value": "High Priority"
    }
  ],
  "translations": [
    {
      "language": "en",
      "name": "Priority Level"
    },
    {
      "language": "de",
      "name": "Prioritätsstufe"
    }
  ],
  "translationsDescriptions": [
    {
      "description": "Priority level for the project",
      "language": "en",
      "name": "Priority Level"
    }
  ],
  "type": "Select"
}'

const response = await fetch("https://leadtime.app/api/public/administration/project-settings/custom-fields/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"Priority level for the project\",\n  \"name\": \"Priority Level\",\n  \"selectOptions\": [\n    {\n      \"id\": \"option-1\",\n      \"translations\": [\n        {\n          \"language\": \"en\",\n          \"name\": \"High Priority\"\n        },\n        {\n          \"language\": \"de\",\n          \"name\": \"Hohe Priorität\"\n        }\n      ],\n      \"value\": \"High Priority\"\n    }\n  ],\n  \"translations\": [\n    {\n      \"language\": \"en\",\n      \"name\": \"Priority Level\"\n    },\n    {\n      \"language\": \"de\",\n      \"name\": \"Prioritätsstufe\"\n    }\n  ],\n  \"translationsDescriptions\": [\n    {\n      \"description\": \"Priority level for the project\",\n      \"language\": \"en\",\n      \"name\": \"Priority Level\"\n    }\n  ],\n  \"type\": \"Select\"\n}"
});

import requests

response = requests.put(
    "https://leadtime.app/api/public/administration/project-settings/custom-fields/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"Priority level for the project\",\n  \"name\": \"Priority Level\",\n  \"selectOptions\": [\n    {\n      \"id\": \"option-1\",\n      \"translations\": [\n        {\n          \"language\": \"en\",\n          \"name\": \"High Priority\"\n        },\n        {\n          \"language\": \"de\",\n          \"name\": \"Hohe Priorität\"\n        }\n      ],\n      \"value\": \"High Priority\"\n    }\n  ],\n  \"translations\": [\n    {\n      \"language\": \"en\",\n      \"name\": \"Priority Level\"\n    },\n    {\n      \"language\": \"de\",\n      \"name\": \"Prioritätsstufe\"\n    }\n  ],\n  \"translationsDescriptions\": [\n    {\n      \"description\": \"Priority level for the project\",\n      \"language\": \"en\",\n      \"name\": \"Priority Level\"\n    }\n  ],\n  \"type\": \"Select\"\n}",
)

Response

{
  "description": "Priority level for the project",
  "entity": "Project",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Priority Level",
  "selectOptions": [
    {
      "id": "option-1",
      "translations": [
        {
          "language": "en",
          "name": "High Priority"
        },
        {
          "language": "de",
          "name": "Hohe Priorität"
        }
      ],
      "value": "High Priority"
    }
  ],
  "sort": 1,
  "translations": [
    {
      "description": "Priority level for the project",
      "language": "en",
      "name": "Priority Level"
    }
  ],
  "type": "Select"
}