Update workspace basic settings

Updates workspace basic settings. All fields are optional - only provided fields will be updated.

What can be updated:

Brand color: Hex color code for workspace branding
Default language: Default language for the workspace (e.g., “en”, “de”)
Country of operation: ISO country code (e.g., “US”, “DE”)
Timezone: IANA timezone identifier (e.g., “America/New_York”, “Europe/Berlin”)
Attendance tracking: Enable or disable attendance tracking for employees
Time tracking thresholds: Percentage thresholds for marking time tracking as “good” or “bad”
Default working hours: Default start and end times for employees
Time tracker reminders: Interval in minutes for reminding users to track time (5-120 minutes)
Sprint configuration: Sprint duration in days, start day (1=Monday), and end day
Journal notifications: List of user IDs who should receive notifications for journal entries

Validation rules:

timeColorBadPercent must be less than timeColorGoodPercent
defaultTimeTo must be after defaultTimeFrom
timeTrackerAnnoyanceInMin must be between 5 and 120
sprintStartDay and sprintEndDay must be between 1 (Monday) and 7 (Sunday)

Note: This endpoint requires the WsSettings.manageSettings permission. Changes affect the entire workspace and all users.

PATCH/administration/basic-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

attendanceEnabledboolean

Whether attendance tracking (clock in/out) is enabled for employees. When enabled, employees must actively clock in and out. When disabled, working hours are calculated automatically based on contract times.

brandColorstring

Brand color in hex format (e.g., #FF5733). Used for workspace branding and internal project colors throughout the application.

countryOfOperationstring

ISO 3166-1 alpha-2 country code (2 uppercase letters) for the country where the company operates. Example: "US" for United States, "DE" for Germany.

defaultLanguagestring

Default language code for the workspace. Supported values: "en" (English) or "de" (German). This applies to new users; each user can override this in their profile.

defaultTimeFromstring<date-time>

Default work start time for employees. Used as a preset when employees clock in. ISO 8601 datetime format. Must be before defaultTimeTo if both are provided.

defaultTimeTostring<date-time>

Default work end time for employees. Used as a preset when employees clock out. ISO 8601 datetime format. Must be after defaultTimeFrom if both are provided.

journalNotificationUserIdsstring[]

Array of user IDs (UUIDs) who should receive notifications when journal entries are created or updated. Journal entries document events, notes, or observations for employees, projects, or organizations.

sprintEndDaynumber

Sprint end day of the week (1-7, where 1=Monday, 2=Tuesday, ..., 7=Sunday). Defines when each sprint period ends. If not provided, calculated from sprintPeriodDays.

sprintPeriodDaysnumber

Sprint duration in days. Defines how long each sprint period lasts. Commonly used values: 7 (one week), 14 (two weeks), or 30 (one month).

sprintStartDaynumber

Sprint start day of the week (1-7, where 1=Monday, 2=Tuesday, ..., 7=Sunday). Defines when each sprint period begins.

timeColorBadPercentnumber

Lower threshold percentage (1-100) for marking time tracking as "bad" or incomplete. Times below this percentage are marked red on the team calendar. Must be less than timeColorGoodPercent.

timeColorGoodPercentnumber

Upper threshold percentage (1-100) for marking time tracking as "good" or complete. Times above this percentage are marked green on the team calendar. Must be greater than timeColorBadPercent.

timeTrackerAnnoyanceInMinnumber

Time tracker reminder interval in minutes (5-120). After this many minutes of inactivity, the system reminds users to resume time tracking. Example: 15 means reminders every 15 minutes.

timezonestring

IANA timezone identifier for the workspace. Defines the timezone used for all time-related information. Example: "America/New_York", "Europe/Berlin", "Asia/Tokyo".

Responses

200

successbooleanrequired

Operation success flag

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

Bodyapplication/json

Request body

Request

curl -X PATCH "https://leadtime.app/api/public/administration/basic-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "attendanceEnabled": true,
  "brandColor": "#FF5733",
  "countryOfOperation": "US",
  "defaultLanguage": "en",
  "defaultTimeFrom": "2019-08-24T14:15:22Z",
  "defaultTimeTo": "2019-08-24T14:15:22Z",
  "journalNotificationUserIds": [
    "string"
  ],
  "sprintEndDay": 5,
  "sprintPeriodDays": 14,
  "sprintStartDay": 1,
  "timeColorBadPercent": 30,
  "timeColorGoodPercent": 70,
  "timeTrackerAnnoyanceInMin": 15,
  "timezone": "America/New_York"
}'

const response = await fetch("https://leadtime.app/api/public/administration/basic-settings", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"attendanceEnabled\": true,\n  \"brandColor\": \"#FF5733\",\n  \"countryOfOperation\": \"US\",\n  \"defaultLanguage\": \"en\",\n  \"defaultTimeFrom\": \"2019-08-24T14:15:22Z\",\n  \"defaultTimeTo\": \"2019-08-24T14:15:22Z\",\n  \"journalNotificationUserIds\": [\n    \"string\"\n  ],\n  \"sprintEndDay\": 5,\n  \"sprintPeriodDays\": 14,\n  \"sprintStartDay\": 1,\n  \"timeColorBadPercent\": 30,\n  \"timeColorGoodPercent\": 70,\n  \"timeTrackerAnnoyanceInMin\": 15,\n  \"timezone\": \"America/New_York\"\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/administration/basic-settings",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"attendanceEnabled\": true,\n  \"brandColor\": \"#FF5733\",\n  \"countryOfOperation\": \"US\",\n  \"defaultLanguage\": \"en\",\n  \"defaultTimeFrom\": \"2019-08-24T14:15:22Z\",\n  \"defaultTimeTo\": \"2019-08-24T14:15:22Z\",\n  \"journalNotificationUserIds\": [\n    \"string\"\n  ],\n  \"sprintEndDay\": 5,\n  \"sprintPeriodDays\": 14,\n  \"sprintStartDay\": 1,\n  \"timeColorBadPercent\": 30,\n  \"timeColorGoodPercent\": 70,\n  \"timeTrackerAnnoyanceInMin\": 15,\n  \"timezone\": \"America/New_York\"\n}",
)

Response

{
  "success": true
}