---
title: "Patch Environment Settings"
method: PATCH
path: "/api/v1/management/environment-settings"
tags: ["Environment-Settings"]
---

# Patch Environment Settings

`PATCH /api/v1/management/environment-settings`

Patch environment settings

## Request body

- SettingsInternalPatch
  - `customColor` string, color, nullable
  - `customLogoUrl` string, uri, nullable
  - `customThemeOverride` CustomThemeOverride
    - `borderRadius` BorderRadiusConfig
      - `button` 'none' | 'lg' | 'md' | 'sm' | 'full'
      - `card` 'none' | 'lg' | 'md' | 'sm' | 'full'
      - `input` 'none' | 'lg' | 'md' | 'sm' | 'full'
    - `fontSize` FontSizeConfig
      - `base` integer, nullable
  - `customStringsOverride` CustomStringsOverride
    - `channelsOne` string, nullable
    - `channelsMany` string, nullable
    - `channelsHelp` string, nullable
  - `customBaseFontSize` integer, nullable
  - `customFontFamily` string, nullable
  - `customFontFamilyUrl` string, uri, nullable
  - `disableEndpointOnFailure` boolean
  - `displayName` string, nullable
  - `enableChannels` boolean
  - `enableEndpointMtlsConfig` boolean
  - `enableEndpointOauthConfig` boolean
  - `enableIntegrationManagement` boolean
  - `enableMessageStream` boolean
  - `enableMsgAtmptLog` boolean
  - `enableOtlp` boolean
  - `enableTransformations` boolean
  - `enforceHttps` boolean
  - `eventCatalogPublished` boolean
  - `readOnly` boolean
  - `requireEndpointChannel` boolean
  - `requireEndpointFilterTypes` boolean
  - `retryPolicy` integer[], nullable
  - `whitelabelHeaders` boolean
  - `sendSvixWebhookHeaders` boolean
  - `colorPaletteLight` CustomColorPalette
    - `primary` string, color, nullable
    - `backgroundPrimary` string, color, nullable
    - `backgroundSecondary` string, color, nullable
    - `backgroundHover` string, color, nullable
    - `textPrimary` string, color, nullable
    - `textSecondary` string, color, nullable
    - `textDanger` string, color, nullable
    - `interactiveAccent` string, color, nullable
    - `navigationAccent` string, color, nullable
    - `buttonPrimary` string, color, nullable
    - `borderPrimary` string, color, nullable
  - `colorPaletteDark` CustomColorPalette
    - `primary` string, color, nullable
    - `backgroundPrimary` string, color, nullable
    - `backgroundSecondary` string, color, nullable
    - `backgroundHover` string, color, nullable
    - `textPrimary` string, color, nullable
    - `textSecondary` string, color, nullable
    - `textDanger` string, color, nullable
    - `interactiveAccent` string, color, nullable
    - `navigationAccent` string, color, nullable
    - `buttonPrimary` string, color, nullable
    - `borderPrimary` string, color, nullable
  - `showUseSvixPlay` boolean
  - `wipeSuccessfulPayload` boolean
  - `enableApplicationAlerts` boolean
  - `applicationAlertEvents` ApplicationAlertEvent[]
  - `applicationAlertsDashboardUrl` string, uri, nullable
  - `applicationAlertsLogoUrl` string, uri, nullable
  - `showFeatureTooltips` boolean
  - `webhooksAutoConfig` boolean
  - `mcpToken` boolean

## Response `200`

- SettingsInternalOut
  - `showSvixBrandFooter` boolean
  - `whitelabelLogo` string, uri, nullable
  - `retryPolicy` integer[], nullable
  - `requireEndpointChannel` boolean
  - `whitelabelHeaders` boolean
  - `sendSvixWebhookHeaders` boolean
  - `enableMsgAtmptLog` boolean
  - `enableOtlp` boolean
  - `customColor` string, color, nullable
  - `customLogoUrl` string, uri, nullable
  - `customThemeOverride` CustomThemeOverride
    - `borderRadius` BorderRadiusConfig
      - `button` 'none' | 'lg' | 'md' | 'sm' | 'full'
      - `card` 'none' | 'lg' | 'md' | 'sm' | 'full'
      - `input` 'none' | 'lg' | 'md' | 'sm' | 'full'
    - `fontSize` FontSizeConfig
      - `base` integer, nullable
  - `customStringsOverride` CustomStringsOverride
    - `channelsOne` string, nullable
    - `channelsMany` string, nullable
    - `channelsHelp` string, nullable
  - `customBaseFontSize` integer, nullable
  - `customFontFamily` string, nullable
  - `customFontFamilyUrl` string, uri, nullable
  - `disableEndpointOnFailure` boolean
  - `displayName` string, nullable
  - `eventCatalogPublished` boolean
  - `enforceHttps` boolean
  - `enableChannels` boolean
  - `enableMessageStream` boolean
  - `readOnly` boolean
  - `enableIntegrationManagement` boolean
  - `enableTransformations` boolean
  - `requireEndpointFilterTypes` boolean
  - `enableEndpointOauthConfig` boolean
  - `enableEndpointMtlsConfig` boolean
  - `colorPaletteLight` CustomColorPalette
    - `primary` string, color, nullable
    - `backgroundPrimary` string, color, nullable
    - `backgroundSecondary` string, color, nullable
    - `backgroundHover` string, color, nullable
    - `textPrimary` string, color, nullable
    - `textSecondary` string, color, nullable
    - `textDanger` string, color, nullable
    - `interactiveAccent` string, color, nullable
    - `navigationAccent` string, color, nullable
    - `buttonPrimary` string, color, nullable
    - `borderPrimary` string, color, nullable
  - `colorPaletteDark` CustomColorPalette
    - `primary` string, color, nullable
    - `backgroundPrimary` string, color, nullable
    - `backgroundSecondary` string, color, nullable
    - `backgroundHover` string, color, nullable
    - `textPrimary` string, color, nullable
    - `textSecondary` string, color, nullable
    - `textDanger` string, color, nullable
    - `interactiveAccent` string, color, nullable
    - `navigationAccent` string, color, nullable
    - `buttonPrimary` string, color, nullable
    - `borderPrimary` string, color, nullable
  - `showUseSvixPlay` boolean
  - `wipeSuccessfulPayload` boolean
  - `enableApplicationAlerts` boolean
  - `applicationAlertEvents` ApplicationAlertEvent[]
  - `applicationAlertsDashboardUrl` string, uri, nullable
  - `applicationAlertsLogoUrl` string, uri, nullable
  - `showFeatureTooltips` boolean
  - `webhooksAutoConfig` boolean
  - `mcpToken` boolean

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Validation Error
- `429` — Too Many Requests

---

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