---
title: "Update the Studio config"
method: PUT
path: "/api/v1/studio/config"
tags: ["Studio"]
---

# Update the Studio config

`PUT /api/v1/studio/config`

## Request

- Base URL: `https://api.sudomock.com`
- URL: `https://api.sudomock.com/api/v1/studio/config`
- Auth: API key in header `x-api-key`

Updates the Studio appearance and controls for this API key.

## Request body

- UpdateStudioConfigRequest
  - `config_version` integer, required: Version you last read, which must still be the stored one.
  - `config` StudioConfigPatch, required
    - `primaryColor` string, nullable: Primary color of the editor interface.
    - `accentColor` string, nullable: Accent color for highlights and active states in the editor.
    - `backgroundColor` string, nullable: Background color of the editor.
    - `panelBackground` string, nullable: Background color of the editor panels.
    - `textColor` string, nullable: Color of the text in the editor.
    - `borderColor` string, nullable: Color of the borders and dividers in the editor.
    - `successColor` string, nullable: Color the editor uses to confirm a completed action.
    - `borderRadius` integer, nullable: Corner radius of the editor controls, in pixels.
    - `logoUrl` string, nullable: HTTPS address of the logo shown in the editor header.
    - `fontFamily` string, nullable: Font family the editor uses for its own text.
    - `headerText` string, nullable: Title shown in the editor header.
    - `uploadText` string, nullable: Prompt shown in the editor upload area.
    - `secondaryActionLabel` string, nullable: Label on the editor secondary action button.
    - `loadingText` string, nullable: Text shown while the primary action is running.
    - `successText` string, nullable: Text shown once the primary action succeeds.
    - `psdPrimaryActionLabel` string, nullable: Label on the primary action button in the PSD editor.
    - `twoDSetupPrimaryActionLabel` string, nullable: Label on the primary action button in a photo mockup setup session.
    - `twoDCustomizePrimaryActionLabel` string, nullable: Label on the primary action button in a photo mockup customize session.
    - `psdShowAdjustments` boolean, nullable: Shows or hides the image adjustment controls in the PSD editor.
    - `psdShowColorOverlay` boolean, nullable: Shows or hides the color overlay control in the PSD editor.
    - `psdShowTextLayers` boolean, nullable: Shows or hides the text layer controls in the PSD editor.
    - `psdShowFitMode` boolean, nullable: Shows or hides the fit mode control in the PSD editor.
    - `psdShowPosition` boolean, nullable: Shows or hides the position controls in the PSD editor.
    - `psdShowSize` boolean, nullable: Shows or hides the size controls in the PSD editor.
    - `psdShowRotation` boolean, nullable: Shows or hides the rotation control in the PSD editor.
    - `psdShowFlip` boolean, nullable: Shows or hides the flip controls in the PSD editor.
    - `psdShowExportOptions` boolean, nullable: Shows or hides the export options in the PSD editor.
    - `psdShowZoomControls` boolean, nullable: Shows or hides the zoom controls in the PSD editor.
    - `psdShowUndoRedo` boolean, nullable: Shows or hides the undo and redo controls in the PSD editor.
    - `psdAutoRender` boolean, nullable: Renders a new preview after each change in the PSD editor.
    - `psdAutoRenderDelay` integer, nullable: Milliseconds the PSD editor waits after a change before it renders.
    - `autoDesignCallback` boolean, nullable: Reports design changes to your page while the shopper edits.
    - `psdLayout` 'full' | 'compact', nullable: Layout of the PSD editor, full or compact.
    - `twoDShowArtwork` boolean, nullable: Shows or hides the artwork upload control in the photo mockup editor.
    - `twoDShowFill` boolean, nullable: Shows or hides the fill color control in the photo mockup editor.
    - `twoDShowBlend` boolean, nullable: Shows or hides the blend mode control in the photo mockup editor.
    - `twoDShowOpacity` boolean, nullable: Shows or hides the opacity control in the photo mockup editor.
    - `twoDShowTransform` boolean, nullable: Shows or hides the transform controls in the photo mockup editor.
    - `twoDShowZoom` boolean, nullable: Shows or hides the zoom controls in the photo mockup editor.
    - `twoDShowExport` boolean, nullable: Shows or hides the export options in the photo mockup editor.
    - `twoDShowBackgroundRemoval` boolean, nullable: Shows or hides the background removal control in the photo mockup editor.
    - `colorPalette` PaletteColour[], nullable: Named colors the product comes in, and the only ones the editor offers.
      - `hex` string, required: Color value as a #rrggbb hex string.
      - `label` string, nullable: Your own name for this color.
    - `showClose` boolean, nullable: Shows or hides the close button in the editor header.
    - `theme` 'light' | 'dark', nullable: Theme the editor opens in, light or dark.
    - `locale` 'en' | 'tr', nullable: Language the editor panel is shown in.
    - `maxFileSize` integer, nullable: Largest upload the editor accepts, in megabytes.

## Response `200`

Successful Response

- StudioConfigResponse
  - `success` boolean: True when the configuration was returned.
  - `config` object: The effective Studio configuration for this API key.
  - `config_version` integer: Version of the stored configuration, which rises with every update.

---

[API](https://skmtc.dev/sudomock/apis/sudomock-api.md) · [All operations](https://skmtc.dev/sudomock/apis/sudomock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sudomock/apis/sudomock-api/revisions/c1cc24006c60?raw)