Update organization custom fields

Updates only the custom field values for an organization. This endpoint is optimized for updating custom fields without affecting other organization data.

Request body:

customFields: Object with custom field IDs as keys and their values
- Keys should match custom field IDs configured in workspace settings
- Values must match the field type (string, number, boolean, date, etc.)
- Use the GET /administration/organization-settings/custom-fields endpoint to retrieve available custom fields

Example:

{
  "customFields": {
    "field-id-1": "Text value",
    "field-id-2": 123,
    "field-id-3": true,
    "field-id-4": "2024-01-01"
  }
}

Note: This endpoint requires the Organizations.edit permission. The organization must exist in your workspace and not be deleted.

PATCH/organizations/{id}/custom-fields

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

customFieldsobjectrequired

Custom field values as key-value pairs

Responses

200

addressCityobject

City

addressCountryobject

Country

addressHouseNumberobject

House number

addressStreetobject

Street address

addressZipobject

ZIP/Postal code

baseInvoiceInterestobject

Base invoice interest rate

colorstringrequired

Organization color (hex code)

createdAtstringrequired

Creation timestamp

customFieldsobject

Custom field values as key-value pairs. Keys match custom field IDs configured in workspace settings. Values match the field type (string, number, boolean, date, etc.). Use the GET /administration/organization-settings/custom-fields endpoint to retrieve available custom fields.

emailobject

Email address

enableInvoiceInterestobject

Enable invoice interest

enableInvoiceReminderFeeobject

Enable invoice reminder fee

faxNumberobject

Fax number

hourRateobject

Hourly rate

iconobject

Icon identifier

idstringrequired

Organization ID

invoiceDueDaysobject

Invoice due days

invoiceInterestobject

Invoice interest rate

invoiceLanguageobject

Invoice language code

invoiceReminderFeeobject

Invoice reminder fee amount

isActivebooleanrequired

Whether organization is active

legalFormobject

Legal form

logoUrlobject

Logo URL (publicly accessible)

namestringrequired

Organization name

parentOrganizationIdobject

Parent organization ID (for hierarchical organization structure)

parentOrganizationNameobject

Parent organization name

phoneNumberobject

Phone number

projectDocumentDefaultContactUserIdobject

Default contact user ID for project documents

projectDocumentEnableTocobject

Enable table of contents in project documents

projectDocumentHeadingStyleobject

Heading style for project documents

projectDocumentTitlePageobject

Show title page in project documents

registrationCourtobject

Registration court

registrationNumberobject

Registration number

shortDescriptionobject

Short description

shortNameobject

Short identifier

startOfCollaborationstring<date>

Start of collaboration date

tagsstring[]

Array of tag UUIDs assigned to this organization. Tags enable cross-project organization and filtering.

taxNumberobject

Tax identification number

typestringrequired

Organization type

Allowed:CustomerProspectTargetPartnerSupplierServiceProviderInvestorCompetitorGovernmentAgencyEducationalInstitution

updatedAtstringrequired

Last update timestamp

websiteobject

Website URL

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/organizations/string/custom-fields" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "customFields": {}
}'

const response = await fetch("https://leadtime.app/api/public/organizations/string/custom-fields", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"customFields\": {}\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/organizations/string/custom-fields",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"customFields\": {}\n}",
)

Response

{
  "addressCity": "New York",
  "addressCountry": "USA",
  "addressHouseNumber": "42A",
  "addressStreet": "123 Main St",
  "addressZip": "10001",
  "baseInvoiceInterest": 3,
  "color": "#FF5733",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "customFields": {
    "customField1": "value1",
    "customField2": 123
  },
  "email": "contact@acme.com",
  "enableInvoiceInterest": false,
  "enableInvoiceReminderFee": true,
  "faxNumber": "+1234567891",
  "hourRate": 150,
  "icon": "building",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceDueDays": 30,
  "invoiceInterest": 5,
  "invoiceLanguage": "en",
  "invoiceReminderFee": 5,
  "isActive": true,
  "legalForm": "GmbH",
  "logoUrl": "https://app.example.com/api/files/public/123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentOrganizationName": "B. Braun",
  "phoneNumber": "+1234567890",
  "projectDocumentDefaultContactUserId": "123e4567-e89b-12d3-a456-426614174000",
  "projectDocumentEnableToc": true,
  "projectDocumentHeadingStyle": "classic",
  "projectDocumentTitlePage": true,
  "registrationCourt": "Munich District Court",
  "registrationNumber": "HRB 12345",
  "shortDescription": "Leading software development company",
  "shortName": "ACME",
  "startOfCollaboration": "2024-01-01",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001"
  ],
  "taxNumber": "DE123456789",
  "type": "Customer",
  "updatedAt": "2024-01-15T12:30:00.000Z",
  "website": "https://acme.com"
}