Initialization Option Author API

tags_on_create

Specifies Tag objects which are added to a new Activity when saved.

You would want to use this so that you can easily assign default Tags based on your own content categories.

Note Tag types defined in the hide_tags and tags_on_create initialization options will be saved but not displayed in the UI.

A maximum of 50 Tags are allowed.

Examples

// Default Tags to apply for new Activities
var initializationOptions = {
    "config": {
        "activity_edit": {
            "tags_on_create": [
                {
                    "type": "Subject",
                    "name": "Math"
                },
                {
                    "type": "Grade",
                    "name": "Grade 9"
                }
            ]
        }
    }
};

Values

Request object key config.activity_edit.tags_on_create

Default: []

Type array[tagsV2]

Type definitions

tagsV2 object

Tags are used to improve searching for content while authoring and for reporting and analytics purposes.

See Understanding Tag Formats for Content Creation and Filtering for more information.

  • name string

    The Tag name.

    Maximum length is 255 characters.

  • type string

    The Tag type.

    Maximum length is 255 characters.

Related articles

Was this article helpful?