---
title: "PATCH /workspaces/{slug}"
method: PATCH
path: "/workspaces/{slug}"
---

# PATCH /workspaces/{slug}

`PATCH /workspaces/{slug}`

## Path parameters

- `slug` string, required

## Request body

- object
  - `name` string
  - `slug` string
  - `settings` object
    - `version` string
    - `workspace` object
      - `sso` object
        - `protocols` object
          - `openId` string, required
          - `saml` string, required
        - `protocol` 'openId' | 'saml'
        - `enabled` boolean
        - `automaticProvisioning` boolean
    - `configuration` object
      - `restrictions` object
        - `flags` object
          - `annotate` object
            - `byline` boolean
          - `footer` object
            - `datawrapperAttribution` boolean
            - `downloadImage` boolean
            - `downloadPdf` boolean
            - `downloadSvg` boolean
            - `embed` boolean
            - `getTheData` boolean
          - `layout` object
            - `layoutSelector` boolean
            - `outputLocale` boolean
          - `sharing` object
            - `socialSharing` boolean
        - `restrictDefaultThemes` boolean
        - `disableVisualizations` object
          - `enabled` boolean — Deprecated. Changing this property will have no effect.
          - `allowAdmins` boolean
          - `visualizations` object
            - `string` boolean
        - `disableBasemaps` object
          - `allowAdmins` boolean
          - `enabled` boolean
          - `basemaps` string[]
      - `hidden` object
        - `enableEditThisChart` boolean
        - `zipEmbedJs` boolean
        - `privateBasemapGroups` object
          - `string` boolean
        - `customFormats` object
          - `date` object[]
            - `label` string
            - `value` string
          - `number` object[]
            - `label` string
            - `value` string
        - `locales` object
          - `numeral` object
          - `dayjs` object
      - `hosting` object
        - `publish` object
          - `providers` object
            - `sftp` object
              - …
            - `s3` object
              - …
            - `gcs` object
              - …
          - `config` object
            - `disableRedirect` boolean
            - `hashPublishing` boolean
            - `urls` object
              - …
            - `trackVisualizationViews` boolean
            - `disableRedirects` boolean
          - `provider` 'dwcdn' | 's3' | 'sftp' | 'gcs'
        - `export` object
          - `pdf` object
            - `ftp` object
              - …
            - `s3` object
              - …
      - `formats` object
        - `images` object
          - `download` object
            - `format` string
            - `filenameTemplate` string
          - `waitForImagesDuringPublish` boolean
          - `publishFormats` object[]
            - `id` string
            - `borderWidth` number — outer padding, for PNG images
            - `dark` boolean
            - `filename` string
            - `format` 'png' | 'pdf' | 'svg'
            - `height` number
            - `width` number
            - `plain` boolean
            - `logo` 'on' | 'off' | 'auto'
            - `zoom` number — scale factor, for PNG images
            - `scale` number — scale factor, for PDF files
            - `transparent` boolean — determines if PNG background will be transparent or opaque
            - `ligatures` boolean
            - `colorMode` boolean — Color mode, for PDF
            - `unit` 'mm' | 'in' | 'px' — Unit of chosen dimensions, for PDF
        - `data` object
          - `download` object
            - `filenameTemplate` string
            - `localized` boolean
      - `integrations` object
        - `slack` object
          - `enabled` boolean
          - `webhookUrl` string
        - `msTeams` object
          - `enabled` boolean
          - `webhookUrl` string
        - `custom` object
          - `enabled` boolean
          - `webhookUrl` string
          - `unpublishWebhookUrl` string
      - `customFields` object
        - `fields` object[]
          - `key` string, required
          - `title` string, required
          - `type` 'text' | 'number' | 'radio' | 'checkbox' | 'textArea' | 'select', required
          - `description` string, required
          - `items` string, required
          - `displayInArchive` boolean, required
          - `inWorkspace` boolean
      - `preferences` object
        - `defaults` object
          - `height` number
          - `width` number
          - `basemap` string
          - `locale` string
          - `theme` string
          - `embed` object
            - `custom` object
              - …
            - `code` 'responsive' | 'iframe' | 'web-component' | 'custom'
          - `webToPrint` boolean
        - `preview` object
          - `widths` object
            - `mobile` integer
            - `tablet` integer
            - `desktop` integer
  - `secrets` object
    - `workspace` object
      - `sso` object
        - `protocols` object
          - `openId` object
            - `clientSecret` string
          - `saml` object
            - `certificate` string
    - `configuration` object
      - `hosting` object
        - `publish` object
          - `providers` object
            - `sftp` object
              - …
            - `s3` object
              - …
            - `gcs` object
              - …
        - `export` object
          - `pdf` object
            - `ftp` object
              - …
            - `s3` object
              - …
  - `color` string

## Response `default`

Successful

---

[API](https://skmtc.dev/datawrapper/apis/datawrapper-api-v3-documentation.md) · [All operations](https://skmtc.dev/datawrapper/apis/datawrapper-api-v3-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/datawrapper/datawrapper-api-v3-documentation/revisions/e190512863c7/schema)