---
title: "Update an existing org config"
method: PATCH
path: "/v1/org/{orgId}/config"
tags: ["org-config"]
---

# Update an existing org config

`PATCH /v1/org/{orgId}/config`

## Path parameters

- `orgId` string, required

## Request body

- UpdateOrgConfig
  - `hiddenFieldIds` string[] — set of hidden field ids of an org
  - `builtinCategoryMap` BuiltInCategoryMap[] — set of maps of the custom fields that belongs to a built-in category
    - `categoryId` string, required — id of the built-in category
    - `fieldIds` string[], required — set of custom field ids that belongs to the built-in category
  - `builtinFieldConfig` BuiltInFieldConfig[] — Org configuration for built-in fields
    - `name` string, required — reserved codename for the native field
    - `hidden` boolean, required — hidden state of the native field (specific to org)
    - `places` integer — decimal places to round native Money fields
  - `compensationBandsConfig` CompensationBandsConfig
    - `annualizedSalaries` boolean, required — whether annualized salaries are used
    - `annualizedSalariesType` string — how annualized salaries are represented
    - `hourlySalaries` boolean, required — whether hourly salaries are used
    - `hourlySalariesType` string — how hourly salaries are represented
    - `hoursPerWeek` number, required — how many hours per week to use when calculating comp bands
    - `weeksPerYear` number, required — how many weeks per year to use when calculating comp bands
    - `hasTargetSalary` boolean, required — target salary within a comp band
    - `targetSalaryType` string — how target salaries are represented
    - `equityFormat` string — equity format
    - `refreshEquityFormat` string — refresh grant equity format
    - `variableBonusFormat` string — variable bonus format
    - `tiersNotMappedToCodes` boolean — whether or not the tiers are mapped to fields. after we migrate all the tiers to be mapped, this flag can be removed
    - `firstTier` string — the org's first tier for their comp bands
    - `secondTier` string — the org's second tier for their comp bands
    - `thirdTier` string — the org's third tier for their comp bands
    - `hasLocationMultiplier` boolean, required — whether the org's location data is used as multipliers
    - `jobLevelSource` string — the source for the band job levels
    - `marketJobLevelSystem` string — comparable market job level system
    - `currencyRounding` Money[], required — currency rounding settings in the UI
      - `amount` number, required
      - `currency` string, required
      - `places` integer
    - `hasMigratedBands` boolean — has migrated V1 bands
    - `startingSalaryConfig` StartingSalaryConfig
      - `type` 'BAND_MINIMUM' | 'BAND_QUARTER' | 'BAND_MIDPOINT' | 'CUSTOM_PERCENTILE', required — Starting salary calculation type
      - `customPercentile` integer — Custom percentile value (0-100) when type is CUSTOM_PERCENTILE
      - `effectiveDate` string, date, required — Effective date for this configuration
      - `includeEquityTarget` boolean — Whether to include equity target in starting compensation
      - `includeVariableComp` boolean — Whether to include variable compensation in starting compensation
  - `smartCurrencyOptions` SmartCurrencyOption[] — Options for where to source a currency to use when currency is unknown. order specific
    - `name` 'PERSON_HOME_ADDRESS_COUNTRY' | 'JOB_LOCATION_COUNTRY' | 'JOB_CURRENCY', required — codename for the option
    - `enabled` boolean, required — determines if this option should be used
  - `smartCurrencyDefault` string — The default currency to use when currency is unknown and there are no options set in smartCurrencyOptions
  - `requiredJobFields` string[] — Org configuration for required job fields
  - `scenarioApprovalChains` object — Configures which approval chains to use with specific scenario types
  - `isOpenJobRoleApprovalEnabled` boolean — Whether to show open job approval on Open Job Profile page
  - `isNotifySubmitterPerStage` boolean — Whether to notify the scenario submitter each time an approval stage completes
  - `jobCodeFieldIds` string[] — The set of field IDs that job codes can be set up to auto-fill
  - `grantConfiguration` GrantAlias[] — Org Grant Configuration
    - `alias` string
    - `grantType` 'ISO' | 'NSO' | 'RSU' | 'SAR' | 'PERFORMANCE_SHARES' | 'PHANTOM_STOCK' | 'RSA', required
    - `enabled` boolean, required

## Response `204`

successful operation

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found
- `500` — internal server error

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/versions/50a1edd6b27e/schema)