• Cheat sheets
  • Documentation
  • API reference
  • Product updates
  • Sign in
Kontent.ai Learn
  • Try Kontent.ai
  • Plan
  • Set up
  • Model
  • Develop
  • Create
Management API v2
API Reference
    • About Management API
    • Postman collection
    • SDKs
    • Authentication
    • API keys
    • API limitations
    • Guidelines on handling changes
      • Introduction
      • Asset element
        Schema
      • Content type snippet element
        Schema
      • Custom element
        Schema
      • Date & time element
        Schema
      • Guidelines element
        Schema
      • Linked items element
        Schema
      • Number element
        Schema
      • Multiple choice element
        Schema
      • Rich text element
        Schema
      • Subpages element
        Schema
      • Taxonomy element
        Schema
      • Text element
        Schema
      • URL slug element
        Schema

Elements in content types

When you retrieve or update content types, you will work with a set of elements.

Asset element

Asset element used in a content type.
name
required · string · 1-50 chars
The element's display name.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
asset_count_limit
nestedSchema
Specifies the limitation for the number of assets allowed within the element.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
maximum_file_size
number · nullable · int32
Specifies the maximum file size in bytes.
allowed_file_types
string
Specifies the allowed file types.
image_width_limit
nestedSchema · nullable
Specifies the width limitation for the asset.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
image_height_limit
nestedSchema · nullable
Specifies the height limitation for the asset.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
default
object · nullable
Specifies the element's initial value.
Renditions are currently not supported in the default value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "name": "Photo",
  "type": "asset",
  "id": "30ca5bc8-4f2a-47b9-a9e7-0d13a2935e10",
  "codename": "photo",
  "external_id": "profile-picture",
  "guidelines": "Optional photo of the author.",
  "asset_count_limit": {
    "value": 1,
    "condition": "exactly"
  },
  "maximum_file_size": 262144,
  "allowed_file_types": "adjustable",
  "image_width_limit": null,
  "image_height_limit": null,
  "is_required": true,
  "is_non_localizable": false,
  "default": {
    "global": {
      "value": {
        "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
        "codename": "object_codename",
        "external_id": "your-own-custom-identifier"
      }
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Content type snippet element

The content type snippet elements contain the snippet property with a reference to a specific content type snippet.Learn more about reusing groups of elements with snippets.
snippet
required · object
Reference to a specific object in the environment.
The API uses internal IDs for referencing objects. This means that the reference objects in the API responses will always use internal IDs.
Show child attributes
type
required · string
The element's type.
id
required · string · read-only · uuid
The element's internal ID.
codename
string · read-only · 1-60 chars
The element's codename. Initially generated from the snippet's name.When modifying content types, you can reference snippet elements by their codename provided the element already exists before making the request.
external_id
string
The element's external ID.
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "snippet": {
    "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
    "codename": "object_codename",
    "external_id": "your-own-custom-identifier"
  },
  "type": "snippet",
  "id": "15e39f98-1586-4f05-b260-36684600b205",
  "codename": "seo_metadata",
  "external_id": "my-seo-metadata",
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Custom element

Create your own custom element, or see the integrations topic on GitHub and the custom elements overview to find custom elements you can use or customize for your scenario.
name
required · string · 1-50 chars
The element's display name.
type
required · string
The element's type.
id
string · read-only · uuid
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
source_url
required · string
Absolute URL that hosts your custom element.
json_parameters
string
Optional parameters that allow you to use the element in different content types or provide customizable layout.The value must be a valid stringified JSON.
allowed_elements[]
array · unique items
Specifies the elements that this custom element can read from.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{"name": "Color picker","type": "custom","id": "2f9dea65-a6d3-49e7-9297-56d8034e8f42","codename": "color_picker","external_id": "color-picker","guidelines": "Always pick colors based on the brand manuals.","is_required": false,"is_non_localizable": false,"source_url": "https://github.com/kontent-ai/custom-element-template-react","json_parameters": ""{\"brand_colors_only\":\"true\"}"","allowed_elements": {"id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53","codename": "object_codename","external_id": "your-own-custom-identifier"},"content_group": {
  "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
}}

Date & time element

name
required · string · 1-50 chars
The element's display name.
guidelines
string
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only · uuid
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "name": "Birth date",
  "guidelines": "Provide the exact birth date and time with one minute precision.",
  "is_required": false,
  "is_non_localizable": true,
  "type": "date_time",
  "id": "4f64afc0-5102-4fad-b564-baadb375ab73",
  "codename": "birth_date",
  "external_id": "birth-date",
  "default": {
    "global": {
      "value": "2019-10-31T00:00:00Z"
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Guidelines element

Guidelines elements do not contain the name property.
guidelines
required · string · 1-100000 chars
Specifies the instructions for contributors on what to insert in the other elements.
The value of the guidelines property must follow the same limitations as the value of rich text elements. In addition, the guidelines element cannot contain content items or components.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's id.
external_id
string
The element's external ID.
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "guidelines": "<p><strong>Naming and usage</strong></p> ...",
  "type": "guidelines",
  "id": "19e15fe8-900a-4456-84eb-16430dc35e88",
  "codename": "n19e15fe8_900a_4456_84eb_16430dc35e88",
  "external_id": "additional-information",
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Linked items element

item_count_limit
nestedSchema
Specifies the limitation for the number of items allowed within the element.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
allowed_content_types[]
array · unique items
Specifies the allowed content types as an array of references to the content types.
Show child attributes
name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "item_count_limit": {
    "value": 1,
    "condition": "exactly"
  },
  "allowed_content_types": {
    "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
    "codename": "object_codename",
    "external_id": "your-own-custom-identifier"
  },
  "name": "Fun facts",
  "guidelines": "Keep them light and fun.",
  "is_required": false,
  "is_non_localizable": false,
  "type": "modular_content",
  "id": "63c0a251-f455-45c8-95bd-542c1358b1a8",
  "codename": "fun_facts",
  "external_id": "my-fun-facts",
  "default": {
    "global": {
      "value": {
        "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
        "codename": "object_codename",
        "external_id": "your-own-custom-identifier"
      }
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Number element

name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only · uuid
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "name": "Number",
  "guidelines": "Provide a number.",
  "is_required": false,
  "is_non_localizable": true,
  "type": "number",
  "id": "b18cbb42-9649-4870-b2d6-805238a34ae9",
  "codename": "number",
  "external_id": "my-number",
  "default": {
    "global": {
      "value": 42
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Multiple choice element

mode
required · string
Defines whether the multiple choice element acts as a single choice (shown as a dropdown menu in the UI) or multiple choice (shown as checkboxes in the UI).
options[]
required · array · unique items
The element's multiple choice options.
Show child attributes
name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "mode": "single",
  "options": {
    "id": "6bfe5a60-5cc2-4303-8f72-9cc53431046b",
    "codename": "option_name",
    "external_id": "custom-option-identifier",
    "name": "Option name"
  },
  "name": "Product state",
  "guidelines": "Specify all possible options.",
  "is_required": true,
  "is_non_localizable": true,
  "type": "multiple_choice",
  "id": "fcc30f1e-9abf-41da-8693-ed89f3be438d",
  "codename": "product_state",
  "external_id": "product-state-id",
  "default": {
    "global": {
      "value": {
        "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
        "codename": "object_codename",
        "external_id": "your-own-custom-identifier"
      }
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Rich text element

maximum_text_length
object · nullable
Specifies the maximum text length.
Show child attributes
maximum_image_size
number · nullable · int32
Specifies the maximum image size in bytes.
allowed_content_types[]
array · unique items
Specifies a list of allowed content types of components and linked items as an array of references. To allow all content types, leave the array empty.
Show child attributes
allowed_item_link_types[]
array · unique items
Specifies content types of items that are allowed to be used in text links as an array of references. The limitation applies to links both in text and in tables. To allow all content types, leave the array empty.
Show child attributes
allowed_blocks[]
array · nullable
Specifies which types of blocks are allowed in the rich text element. To allow all blocks, use an empty array.
allowed_text_blocks[]
array · nullable
Specifies which text blocks are allowed in the rich text element. To allow all text blocks, use an empty array.
allowed_formatting[]
array · nullable
Specifies which text formatting is allowed in the rich text element. To allow all formatting, use an empty array. To allow only plaintext, use ["unstyled"].
The unstyled value must precede any other values in the list.
allowed_table_blocks[]
array · nullable
Specifies which blocks are allowed in tables in the rich text element.Either use ["text"] to allow only text or leave the array empty to allow both text and images.
allowed_table_text_blocks[]
array · nullable
Specifies which text blocks are allowed in tables in the rich text element. You can allow paragraphs, headings, and lists. To allow all text blocks, leave the array empty.
allowed_table_formatting[]
array · nullable
Specifies which text formatting is allowed in tables in the rich text element. To allow all formatting, leave the array empty. To allow only plaintext, use ["unstyled"].
The unstyled value must precede any other values in the list.
image_width_limit
object · nullable

Show child attributes
image_height_limit
object · nullable

Show child attributes
allowed_image_types
string
Specifies which image types are allowed.
name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean · read-only
Determines whether the element uses the same value in all languages. Rich text elements cannot be set as non-localizable.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "maximum_text_length": {
    "value": 60,
    "applies_to": "characters"
  },
  "maximum_image_size": 1048576,
  "allowed_content_types": [],
  "allowed_item_link_types": [],
  "allowed_blocks": [
    "text"
  ],
  "allowed_text_blocks": [
    "paragraph",
    "heading-one",
    "heading-two"
  ],
  "allowed_formatting": [
    "unstyled",
    "bold",
    "italic"
  ],
  "allowed_table_blocks": [
    "text"
  ],
  "allowed_table_text_blocks": [
    "paragraph",
    "heading-one",
    "heading-two"
  ],
  "allowed_table_formatting": [
    "unstyled",
    "bold",
    "italic"
  ],
  "image_width_limit": {
    "value": 256,
    "condition": "at_least"
  },
  "image_height_limit": {
    "value": 256,
    "condition": "at_least"
  },
  "allowed_image_types": "string",
  "name": "string",
  "guidelines": "string",
  "is_required": false,
  "is_non_localizable": false,
  "type": "string",
  "id": "string",
  "codename": "string",
  "external_id": "custom-rich-text-identifier",
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Subpages element

The Subpages element requires Web Spotlight and live preview.
item_count_limit
nestedSchema
Specifies the limitation for the number of items allowed within the element.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
allowed_content_types[]
array · unique items
Specifies allowed file types as an array of references to the content types.
Show child attributes
name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "item_count_limit": {
    "value": 1,
    "condition": "exactly"
  },
  "allowed_content_types": [],
  "name": "Articles",
  "guidelines": "Select pages to show under this navigation item.",
  "is_required": true,
  "is_non_localizable": false,
  "type": "subpages",
  "id": "50b48cc6-ae3b-46f8-8239-fd1eb9f30afe",
  "codename": "articles",
  "external_id": "article-subpages",
  "default": {
    "global": {
      "value": {
        "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
        "codename": "object_codename",
        "external_id": "your-own-custom-identifier"
      }
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Taxonomy element

name
string · 1-50 chars
The element's display name. If not provided when adding the element to a content type, the name is taken from the taxonomy group's name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
taxonomy_group
required · nestedSchema
Specifies a reference to the taxonomy group that the element uses.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
term_count_limit
nestedSchema
Specifies the limitation for the number of terms that can be selected in the element.
value
required · number · int32
Specifies the image size, or how many objects can be used within the element.
condition
required · string
Specifies how to apply the value.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the name of the taxonomy group specified in the taxonomy_group property.
external_id
string
The element's external ID.
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{
  "name": "Personas",
  "guidelines": "Be sure to be in the correct group",
  "taxonomy_group": {
    "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
    "codename": "object_codename",
    "external_id": "your-own-custom-identifier"
  },
  "is_required": false,
  "is_non_localizable": false,
  "term_count_limit": {
    "value": 1,
    "condition": "exactly"
  },
  "type": "taxonomy",
  "id": "fdcdd09e-7599-4f24-b8eb-fdf318e1072e",
  "codename": "personas",
  "external_id": "business-personas",
  "default": {
    "global": {
      "value": {
        "id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
        "codename": "object_codename",
        "external_id": "your-own-custom-identifier"
      }
    }
  },
  "content_group": {
    "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
  }
}

Text element

name
required · string · 1-50 chars
The element's display name.
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
maximum_text_length
object · nullable
Specifies the maximum text length.
Show child attributes
validation_regex
object · nullable
Specifies a regular expression pattern used to validate the element's value.
Show child attributes
default
object · nullable
Specifies the element's initial value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{"name": "Title","guidelines": "Keep it short.","is_required": false,"is_non_localizable": true,"type": "text","id": "7dc115d0-e9f8-4947-9cfb-9a26485975ae","codename": "title","external_id": "my-text-element","maximum_text_length": {"value": 60,"applies_to": "characters"},"validation_regex": {"regex": "^(https?:\/\/(?:www\.|(?!www)))?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$","flags": "i","validation_message": "Type a valid web URL such as https://example.org.","is_active": true},"default": {"global": {"value": "The greatest title"}},"content_group": {
  "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
}}

URL slug element

Learn more about the use of URL slugs and content type snippets within Kontent.ai.
name
required · string · 1-50 chars
The element's display name.
depends_on
required · object
Specifies the text element that provides the default value to the URL slug element. The dependent text element can be part of a content type snippet.
Show child attributes
guidelines
string · nullable
The element's guidelines, providing instructions on what to fill in.
is_required
boolean · nullable
Determines whether the element must be filled in.
is_non_localizable
boolean
Determines whether the element uses the same value in all languages.
type
required · string
The element's type.
id
string · read-only
The element's internal ID.
codename
string · 1-60 chars
The element's codename. Unless specified, initially generated from the element's name.
external_id
string
The element's external ID.
validation_regex
object · nullable
Specifies a regular expression pattern used to validate the element's value.
Show child attributes
content_group
nestedSchema
Reference to the content group the element is used in.The content_group property is present only if one or more content groups are defined in the content type.
id
string · uuid
The referenced object's internal ID.
codename
string · write-only
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
external_id
string · write-only
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
JSON
{"name": "URL slug","depends_on": {
  "element": 
    {
      "id": "c7c3b834-2222-5677-89c4-b46f04489109"
    },
    "snippet": 
      {
        "id": "67faca73-bfd3-4600-b6c4-9cc91cc8d85f"
      }
},"guidelines": "Auto-generated from Title. Only change if necessary.","is_required": false,"is_non_localizable": false,"type": "url_slug","id": "8f43fd1b-e11d-494b-a85f-478db1703c21","codename": "url_slug","external_id": "my-url-slug","validation_regex": {"regex": "^(https?:\/\/(?:www\.|(?!www)))?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$","flags": "i","validation_message": "Type a valid web URL such as https://example.org.","is_active": true},"content_group": {
  "id": "ad1b8cce-94d6-4682-a9ff-393d494e3a02"
}}
Copyright © 2025 Kontent.ai. All rights reserved.
  • Web
  • Privacy policy
  • Cookies policy
  • Consent settings
  • Security
  • GDPR