Update Collection Request Payload

REST API Reference

You can update a collection

namestring

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Example:"collection 51"

descriptionstring

The description of the collection. For multilingual collections, this will be the description of the default language's content.

Example:"English description"

iconstring

The icon of the collection, for example book-bookmark. If you leave out icon, or send it empty, the collection's icon is reset to folder.

Example:"book-bookmark"

translated_contentobject or null(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

parent_idstring or null

The id of the parent collection to move the collection into. Omitting this field or sending null leaves the collection where it is. Send home to move it to the first level.

Example:"6871118"

help_center_idinteger or null

Checked against the collection's Help Center but not applied, so it can't move the collection to another Help Center.

Example:123

{
  "name": "collection 51",
  "description": "English description",
  "icon": "book-bookmark",
  "translated_content": {
    "type": "group_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  },
  "parent_id": "6871118",
  "help_center_id": 123
}