---
title: "Update desk"
method: PUT
path: "/v1/helpcenter/desks/{id}"
tags: ["HelpCenter"]
---

# Update desk

`PUT /v1/helpcenter/desks/{id}`

## Path parameters

- `id` string, required

## Request body

- Desk
  - `_id` string, nullable
  - `_infoset` HelpdeskInfosetData
    - `apiKey` string, required — infoset account api key
    - `id` integer, required
  - `slug` string, required — URL slug for your help center, must match [a-zA-Z0-9-]+, i.e. infoset.help/{yourDeskSlug}
  - `domain` string, nullable — Custom domain for your help center
  - `homepage` string, nullable — Link to your website homepage
  - `defaultLanguage` string, required — Default language code of your help center, e.g. "en" "fr" "tr"
  - `languages` HelpdeskLanguageSettings[], nullable
    - `language` string, required — 2-letter language code
    - `title` string, nullable — Title of the help center for this language
    - `subtitle` string, nullable — Subtitle of the help center for this language
    - `chatWidget` HelpdeskChatWidgetSettings
      - `apiKey` string, nullable — API key of the chat widget to display on the help center
      - `settings` unknown
  - `faviconUrl` string, nullable — Favicon URL
  - `logoUrl` string, nullable — Logo URL
  - `headerImgUrl` string, nullable — Header image URL
  - `socialMediaImgUrl` string, nullable — Social media image URL, displayed on the social media share cards
  - `color` string, required — Theme color of the help center
  - `footerLinks` HelpdeskFooterLink[], nullable
    - `title` string, nullable — Label to display
    - `url` string, nullable — URL for the link
  - `socialLinks` HelpdeskSocialLink[], nullable
    - `platform` string, nullable — Platform of the social link, i.e. "facebook", "twitter", "linkedin"
    - `url` string, nullable — URL for the link, provide just the sub-routes for Facebook or LinkedIn, e.g. for "https://www.linkedin.com/company/acmeinc" provide "company/acmeinc"
  - `showInfosetLink` boolean, nullable — Display the Infoset branding in the footer or not
  - `departmentId` integer, nullable — Brand (Infoset department id) this desk belongs to; null for brand-less/legacy desks
  - `integrations` HelpdeskIntegrations
    - `googleAnalytics` HelpdeskIntegrationGa
      - `enabled` boolean, nullable — Whether Google Analytics integration is enabled
      - `id` string, nullable — Google Analytics ID to track events in your help center
    - `segment` HelpdeskIntegrationSegment
      - `enabled` boolean, nullable — Whether Segment integration is enabled
      - `writeKey` string, nullable — Segment project Write Key to track events in your help center
    - `amplitude` HelpdeskIntegrationAmplitude
      - `enabled` boolean, nullable — Whether Amplitude integration is enabled
      - `apiKey` string, nullable — Amplitude project API Key to track events in your help center
    - `simpleAnalytics` HelpdeskIntegrationSimpleAnalytics
      - `enabled` boolean, nullable — Whether Simple Analytics integration is enabled
    - `plausible` HelpdeskIntegration
      - `enabled` boolean, nullable — Whether Plausible integration is enabled
    - `fathom` HelpdeskIntegrationFathom
      - `enabled` boolean, nullable — Whether Fathom integration is enabled
      - `siteId` string, nullable — Fathom tracking Site ID to track events in your help center
    - `momently` HelpdeskIntegrationMomently
      - `enabled` boolean, nullable — Whether Momently integration is enabled
      - `siteId` string, nullable — Momently Site ID to track events in your help center
    - `disqus` HelpdeskIntegrationDisqus
      - `enabled` boolean, nullable — Whether Disqus integration is enabled
      - `shortname` string, nullable — Disqus shortname for integration
    - `commento` HelpdeskIntegrationCommento
      - `enabled` boolean, nullable — Whether Commento integration is enabled
    - `discourse` HelpdeskIntegrationDiscourse
      - `enabled` boolean, nullable — Whether Discourse integration is enabled
      - `url` string, nullable — Discourse URL for integration
  - `createdAt` unknown
  - `updatedAt` unknown
  - `visibility` DeskVisibilitySettings
    - `type` 1 | 2 | 3 — <p>Enum values:</p><ul><li><i>1 = Everyone</i></li><li><i>2 = Admins</i></li><li><i>3 = Restricted</i></li></ul>
    - `userGroupIds` integer[], nullable

## Response `201`

Created

- Desk
  - `_id` string, nullable
  - `_infoset` HelpdeskInfosetData
    - `apiKey` string, required — infoset account api key
    - `id` integer, required
  - `slug` string, required — URL slug for your help center, must match [a-zA-Z0-9-]+, i.e. infoset.help/{yourDeskSlug}
  - `domain` string, nullable — Custom domain for your help center
  - `homepage` string, nullable — Link to your website homepage
  - `defaultLanguage` string, required — Default language code of your help center, e.g. "en" "fr" "tr"
  - `languages` HelpdeskLanguageSettings[], nullable
    - `language` string, required — 2-letter language code
    - `title` string, nullable — Title of the help center for this language
    - `subtitle` string, nullable — Subtitle of the help center for this language
    - `chatWidget` HelpdeskChatWidgetSettings
      - `apiKey` string, nullable — API key of the chat widget to display on the help center
      - `settings` unknown
  - `faviconUrl` string, nullable — Favicon URL
  - `logoUrl` string, nullable — Logo URL
  - `headerImgUrl` string, nullable — Header image URL
  - `socialMediaImgUrl` string, nullable — Social media image URL, displayed on the social media share cards
  - `color` string, required — Theme color of the help center
  - `footerLinks` HelpdeskFooterLink[], nullable
    - `title` string, nullable — Label to display
    - `url` string, nullable — URL for the link
  - `socialLinks` HelpdeskSocialLink[], nullable
    - `platform` string, nullable — Platform of the social link, i.e. "facebook", "twitter", "linkedin"
    - `url` string, nullable — URL for the link, provide just the sub-routes for Facebook or LinkedIn, e.g. for "https://www.linkedin.com/company/acmeinc" provide "company/acmeinc"
  - `showInfosetLink` boolean, nullable — Display the Infoset branding in the footer or not
  - `departmentId` integer, nullable — Brand (Infoset department id) this desk belongs to; null for brand-less/legacy desks
  - `integrations` HelpdeskIntegrations
    - `googleAnalytics` HelpdeskIntegrationGa
      - `enabled` boolean, nullable — Whether Google Analytics integration is enabled
      - `id` string, nullable — Google Analytics ID to track events in your help center
    - `segment` HelpdeskIntegrationSegment
      - `enabled` boolean, nullable — Whether Segment integration is enabled
      - `writeKey` string, nullable — Segment project Write Key to track events in your help center
    - `amplitude` HelpdeskIntegrationAmplitude
      - `enabled` boolean, nullable — Whether Amplitude integration is enabled
      - `apiKey` string, nullable — Amplitude project API Key to track events in your help center
    - `simpleAnalytics` HelpdeskIntegrationSimpleAnalytics
      - `enabled` boolean, nullable — Whether Simple Analytics integration is enabled
    - `plausible` HelpdeskIntegration
      - `enabled` boolean, nullable — Whether Plausible integration is enabled
    - `fathom` HelpdeskIntegrationFathom
      - `enabled` boolean, nullable — Whether Fathom integration is enabled
      - `siteId` string, nullable — Fathom tracking Site ID to track events in your help center
    - `momently` HelpdeskIntegrationMomently
      - `enabled` boolean, nullable — Whether Momently integration is enabled
      - `siteId` string, nullable — Momently Site ID to track events in your help center
    - `disqus` HelpdeskIntegrationDisqus
      - `enabled` boolean, nullable — Whether Disqus integration is enabled
      - `shortname` string, nullable — Disqus shortname for integration
    - `commento` HelpdeskIntegrationCommento
      - `enabled` boolean, nullable — Whether Commento integration is enabled
    - `discourse` HelpdeskIntegrationDiscourse
      - `enabled` boolean, nullable — Whether Discourse integration is enabled
      - `url` string, nullable — Discourse URL for integration
  - `createdAt` unknown
  - `updatedAt` unknown
  - `visibility` DeskVisibilitySettings
    - `type` 1 | 2 | 3 — <p>Enum values:</p><ul><li><i>1 = Everyone</i></li><li><i>2 = Admins</i></li><li><i>3 = Restricted</i></li></ul>
    - `userGroupIds` integer[], nullable

## Other responses

- `400` — Bad Request

---

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