INinfoset
HelpCenter

Update collection

put/v1/helpcenter/collections/{id}

Request

Path parameters

idinteger required

Collection identifier.

Request body

_idinteger nullable
iconstring nullable

Icon displayed on the collection card, it must be a Font Awesome 5 icon classname, e.g. "fas fa-search"

titlestring required
spoilerstring nullable

Spoiler displayed under the title

languagestring nullable

2-letter language code

sectionsstring[] nullable
orderinteger nullable

Order of the collection in the homepage, if not given creation date will be used

slugstring nullable

Auto-generated URL slug of the collection, e.g. infoset.help/acmeinc/collections/{id}-{slug}

deskstring required

ID of the help center of this collection

departmentIdinteger nullable
previousHelpdeskCollection circular
createdAtunknown
updatedAtunknown

Response

Created

_idinteger nullable
iconstring nullable

Icon displayed on the collection card, it must be a Font Awesome 5 icon classname, e.g. "fas fa-search"

titlestring required
spoilerstring nullable

Spoiler displayed under the title

languagestring nullable

2-letter language code

sectionsstring[] nullable
orderinteger nullable

Order of the collection in the homepage, if not given creation date will be used

slugstring nullable

Auto-generated URL slug of the collection, e.g. infoset.help/acmeinc/collections/{id}-{slug}

deskstring required

ID of the help center of this collection

departmentIdinteger nullable
previousHelpdeskCollection circular
createdAtunknown
updatedAtunknown

Changes

No recorded changes to this operation across all 3 revisions of this API.