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.
Reference to a specific object in the environment.
The element's display name.
The element's type.
The element's internal ID.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
Specifies the instructions for contributors on what to insert in the other elements.
The element's type.
The element's internal ID.
Specifies the limitation for the number of items allowed within the element.
Specifies the image size, or how many objects can be used within the element.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
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).
The element's multiple choice options.
Specifies the maximum text length.
Specifies the limitation for the number of items allowed within the element.
Specifies the image size, or how many objects can be used within the element.
Specifies how to apply the value.
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.
The element's guidelines, providing instructions on what to fill in.
Specifies a reference to the taxonomy group that the element uses.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
The element's display name.
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.
The element's codename. Unless specified, initially generated from the element's name.
The element's guidelines, providing instructions on what to fill in.
Specifies the limitation for the number of assets allowed within the element.
Specifies the image size, or how many objects can be used within the element.
Specifies how to apply the value.
Specifies the maximum file size in bytes.
Specifies the allowed file types.
Specifies the width limitation for the asset.
Specifies the image size, or how many objects can be used within the element.
Specifies the height limitation for the asset.
Specifies the image size, or how many objects can be used within the element.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
Specifies the element's initial value.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's type.
The element's internal ID.
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.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's codename. Unless specified, initially generated from the element's name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
Absolute URL that hosts your custom element.
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.
Specifies the elements that this custom element can read from.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's codename. Unless specified, initially generated from the element's id.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
Determines whether the element uses the same value in all languages.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
Specifies the maximum image size in bytes.
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.
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.
Specifies which types of blocks are allowed in the rich text element. To allow all blocks, use an empty array.
Specifies which text blocks are allowed in the rich text element. To allow all text blocks, use an empty array.
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"].
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.
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.
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"].
Specifies which image types are allowed.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages. Rich text elements cannot be set as non-localizable.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
Specifies allowed file types as an array of references to the content types.
The element's display name.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
Specifies the limitation for the number of terms that can be selected in the element.
Specifies the image size, or how many objects can be used within the element.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
Determines whether the element uses the same value in all languages.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
Specifies a regular expression pattern used to validate the element's value.
Specifies the element's initial value.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
The element's guidelines, providing instructions on what to fill in.
Determines whether the element must be filled in.
Determines whether the element uses the same value in all languages.
The element's type.
The element's internal ID.
The element's codename. Unless specified, initially generated from the element's name.
Specifies a regular expression pattern used to validate the element's value.
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.
The referenced object's internal ID.
The referenced object's codename. The value of the codename property must meet the conditions defined in rules for codenames.
Specifies how to apply the value.
Specifies how to apply the value.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
The referenced object’s external ID. The value of the external_id property must not contain the following characters: /, ., ;.
{"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"}}
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"}}
The API uses internal IDs for referencing objects. This means that the reference objects in the API responses will always use internal IDs.
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.
Renditions are currently not supported in the default value.
The unstyled value must precede any other values in the list.
The unstyled value must precede any other values in the list.
and the custom elements overview
The API uses internal IDs for referencing objects. This means that the reference objects in the API responses will always use internal IDs.