v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring types

Update an existing type.

Use the /types/{id} end-point to update an existing content type within the database.<br />User roles: admin, manager

put/authoring/v1/types/{id}

Path parameters

idstring required

Provide the ID of the content type document that you want to update.

Query parameters

forceOverrideboolean

Specifies whether revision checking should be disabled.

optionsstring

Specify additional update directives. Valid directives are:

rebuild-path-filename: Instructs the service to re-generate the last fragment of the specified document path, by converting the specified document name into a filesystem friendly filename.

Request body

idstring

The ID of the type document.

revstring required

The current revision of the type document.

namestring required

The name of the type document.

descriptionstring required

The description of the type document.

classification'content-type' required

the type document classification.

kindstring[]

Identifies the sub-classification of the type document. Valid values include:

custom-ui: This type document has a custom user interface defined
embedded: This type document can be included within another type document
standalone: This type document can be used to create normal content items
page: This type document can be used to create site pages
landing-page: This type document can be used to create landing pages
email: This type document can be used to create email messages
site: This type document can be used to create sites

creatorIdstring required

creatorstring

The display name of the user that created this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

createdstring date-time

The created date of this type document in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

lastModifierIdstring

lastModifierstring

The display name of the last user that modified this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

lastModifiedstring date-time

The last modified date of this type document in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

pathstring

Optional path to associate with this type document. Must be unique. Will default to filesystem friendly version of /[NAME].

tagsstring[] required

status'draft' | 'ready' | 'retired' required

the workflow status.

linkedDocIdstring

Only present on Drafts created from existing Ready items, this property indicates the ID of the associated Ready item

iconstring[]

Specifies the type of icon to show for this type document within the Type user interface's element palette Only used when the type document has a kind that includes 'embedded'

schemaobject

The Json-Schema representation of this Type document, which can be used to validate a content-item using this Type. This is the same document returned from the '/types/{id}/schema' end-point and is only returned when the 'include' query string option is set to 'ALL' or 'schema'

mappingsobject

The layout mappings of this Type document. This field is only returned when the 'include' query string option is set to 'ALL' or 'mappings'.

isSystemboolean

Indicates whether this item is a 'system item' or not.

Example request

{
  "path": "/myTypes/SampleType.json",
  "thumbnail": {
    "id": "6c622bbb-5f5b-45d4-89e1-fce1c054138f",
    "path": "/sales/images/hub.png",
    "url": "/authoring/v1/resources/47d535ff288b3bd8383009abf82a9ea8"
  }
}

Response

Successfully updated the content type document that matches the ID provided with the changes made to the type fields.