patch/workspace/settingsWrite operation

Update public workspace settings

Atomically compares the complete public settings revision, applies only the six documented settings, durably audits the write, and retains a recoverable credential-owned idempotency record for seven days.

Required scopes

workspace-settings:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/workspace/settings' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "currency": "AUD",
    "defaultLanguage": "de",
    "defaultPlannedTime": 0,
    "defaultProductivity": 0,
    "defaultShowInScheduling": false,
    "name": "string"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/workspace/settings', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "currency": "AUD",
  "defaultLanguage": "de",
  "defaultPlannedTime": 0,
  "defaultProductivity": 0,
  "defaultShowInScheduling": false,
  "name": "string"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/workspace/settings', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "currency": "AUD",
  "defaultLanguage": "de",
  "defaultPlannedTime": 0,
  "defaultProductivity": 0,
  "defaultShowInScheduling": false,
  "name": "string"
}),
})

const result: ApiResponse = await response.json()

teamgrid workspace update \
  --data @payload.json \
  --idempotency-key REQUEST_KEY \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "currency": "AUD",
      "defaultLanguage": "de",
      "defaultPlannedTime": null,
      "defaultProductivity": null,
      "defaultShowInScheduling": null,
      "name": "string",
      "revision": "example"
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

If-Matchheader · requiredIdempotency-Keyheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Headers

If-Matchrequired

string

Exactly one latest strong workspace settings ETag. Wildcards, weak validators, and lists are rejected.

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

currency

string

ISO 4217 currency code used for monetary values.

AUDCADCHFEURGBPNZDUSDZAR

defaultLanguage

string

Canonical default language value for this workspace settings.

dede-XXen

defaultPlannedTime

number

The default planned time associated with this workspace settings.

defaultProductivity

number

The default productivity associated with this workspace settings.

defaultShowInScheduling

boolean

Whether default show in scheduling applies to this workspace settings.

name

string

Human-readable name of the resource.

Responses

200The updated settings, or an exact replay of the original successful result.application/json

Response schemaapplication/json

required

WorkspaceSettings

Public API representation of workspace settings.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

412The resource changed since the supplied revision.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

428A strong If-Match revision is required.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDupdateWorkspaceSettingsOpenAPI JSON ↗

Documentation feedbackWas this page useful?