Update an existing type.

put

https://example.com/authoring/v1/types/{id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

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

Query Params

forceOverride

boolean

Defaults to false

Specifies whether revision checking should be disabled.

options

string

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.

Body Params

Provide all the updated type fields that you want to save to this content type document.

An existing type document.

string

length ≥ 1

The ID of the type document.

rev

string

required

length ≥ 1

The current revision of the type document.

name

string

required

length ≥ 1

The name of the type document.

description

string

required

The description of the type document.

classification

string

enum

required

the type document classification.

Allowed:

kind

array of strings

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

kind

Allowed:

contentThumbnail

object

The thumbnail settings for content using this type.

creatorId

string

required

length ≥ 1

creator

string

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.

created

date-time

length ≥ 1

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

lastModifierId

string

length ≥ 1

lastModifier

string

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.

lastModified

date-time

length ≥ 1

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.

path

string

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

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

400The ID that you provided is invalid. Provide a valid ID.

401You do not have authorization to update this content type document.

404A content type document with the ID {id} was not found or the current tenant's database is not provisioned.

409The content type document was updated by another user since you retrieved it. If you are changing the document path, a content type document with the same path exists in the database. Provide a new path for this content type.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

500Unexpected error.