Sign in
HelpCenter

Update desk

put/v1/helpcenter/desks/{id}

Path parameters

idstring required

desk identifier.

Request body

_idstring nullable
slugstring required

URL slug for your help center, must match [a-zA-Z0-9-]+, i.e. infoset.help/{yourDeskSlug}

domainstring nullable

Custom domain for your help center

homepagestring nullable

Link to your website homepage

defaultLanguagestring required

Default language code of your help center, e.g. "en" "fr" "tr"

faviconUrlstring nullable

Favicon URL

logoUrlstring nullable

Logo URL

headerImgUrlstring nullable

Header image URL

socialMediaImgUrlstring nullable

Social media image URL, displayed on the social media share cards

colorstring required

Theme color of the help center

showInfosetLinkboolean nullable

Display the Infoset branding in the footer or not

departmentIdinteger nullable

Brand (Infoset department id) this desk belongs to; null for brand-less/legacy desks

{"stackTrail":"components:schemas:Desk:properties:createdAt","oasType":"schema","type":"unknown","description":"Creation date","nullable":true}
{"stackTrail":"components:schemas:Desk:properties:updatedAt","oasType":"schema","type":"unknown","description":"Last update date","nullable":true}

Response

Created

_idstring nullable
slugstring required

URL slug for your help center, must match [a-zA-Z0-9-]+, i.e. infoset.help/{yourDeskSlug}

domainstring nullable

Custom domain for your help center

homepagestring nullable

Link to your website homepage

defaultLanguagestring required

Default language code of your help center, e.g. "en" "fr" "tr"

faviconUrlstring nullable

Favicon URL

logoUrlstring nullable

Logo URL

headerImgUrlstring nullable

Header image URL

socialMediaImgUrlstring nullable

Social media image URL, displayed on the social media share cards

colorstring required

Theme color of the help center

showInfosetLinkboolean nullable

Display the Infoset branding in the footer or not

departmentIdinteger nullable

Brand (Infoset department id) this desk belongs to; null for brand-less/legacy desks

{"stackTrail":"components:schemas:Desk:properties:createdAt","oasType":"schema","type":"unknown","description":"Creation date","nullable":true}
{"stackTrail":"components:schemas:Desk:properties:updatedAt","oasType":"schema","type":"unknown","description":"Last update date","nullable":true}

Changes

No recorded changes to this endpoint across all 1 revision of this API.